.net core WebAPI+EF 動態接收前臺json，並動態修改資料庫

阿新 • • 發佈：2020-03-13

用API開發的人都知道，常用的後臺接收引數就是建個DTO，然後前臺把這個DTO傳過來。後臺再更新，例如如下例子：

public async Task<IActionResult> PutModel(DTO model)
{
　　_context.Entry(model).State = EntityState.Modified;
　　var result = await _context.SaveChangesAsync().ConfigureAwait(false);
　　return OK("修改實體成功!");
}

這樣做後臺是很方便，可是EF全部更新效率實在太低，而且沒必要，而且前臺就需要把所有的DTO物件都傳過來，如果有不想要修改的怎麼辦？好吧。用EF的

　　_context.Entry(model).Property(m => m.Field1).IsModified = false;

　　_context.Entry(model).Property(m => m.Field2).IsModified = false;

如果一個表中有50個欄位，有20個需要更新，30個不需要更新，難道寫30個_context.Entry(model).Property(m => m.Field1).IsModified = false;這樣的語句？或者寫20個_context.Entry(model).Property(m => m.Field2).IsModified = true;這樣的語句？這樣開發效率實在太低。。好吧。還有方法2，針對每個表需要修改的部分都建不同的DTO，再用model.Field1=DTO.Field1, 這要去對每個修改的物件都賦值再更改，如果有一百張表呢？那豈不是要建一百個DTO，，我的天，那多累，程式猿無疑是最懶的，如果換作你，你願意花時間建100個DTO嗎？換作我是的話，我肯定不願意。有沒有更捷徑的方法呢？肯定有，那就是用動態傳參[dynamic]，這樣後臺就不需要針對每個要修改的表都建DTO，前臺也不需要把表所有的欄位都傳過來，只需要傳頁面表單有的欄位，也就是修改過的欄位，靈活性大大提高，而且提高了開發效率。好了，不廢話了。開始正題。

由於dynamic不支援跨域，首先要解決跨域問題，在Startup.cs檔案裡新增如下程式碼

　　　　public void ConfigureServices(IServiceCollection services)
        {
            //跨域設定
            services.AddCors(options =>
            {
                options.AddPolicy("allow_all", builder =>
                {
                    builder.AllowAnyMethod().AllowAnyHeader().AllowAnyOrigin();//允許所有域名訪問
　　　　　　　　　　　 //builder.WithOrigins("http://localhost:8088").AllowAnyHeader();//允許指定域名訪問
                });
            });
　　　　　}

　　　　public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IHttpContextAccessor httpContextAccessor)
        {
            app.UseCors("allow_all");
        }

跨域問題解決之後，新增動態修改資料庫的方法。

using Microsoft.AspNetCore.Mvc;
using Microsoft.EntityFrameworkCore;
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Reflection;

namespace ASP.NET.Core.EF
{
    /// <summary>頁面基類</summary>
    public class PageBase : ControllerBase
    {
        /// <summary>資料連線</summary>
        protected readonly DBContext _context;//方式1

        /// <summary>建構函式 初始化資料庫連線</summary>
        /// <param name="context">資料連線</param>
        public PageBase(DBContext context)
        {
            _context = context;
        }

        /// <summary>
        /// 更新指定實體
        /// </summary>
        /// <typeparam name="T">資料表實體Model模型</typeparam>
        /// <param name="modelNew">動態Json資料</param>
        protected virtual void Update<T>(dynamic modelNew)
        {
            //序列化動態Json為字串
            string json = modelNew.ToString();

            //反序列化為資料表中的實體物件
            T model = JsonConvert.DeserializeObject<T>(json);

            //把狀態全部變為不可更改
            _context.Entry(model).State = EntityState.Unchanged;

            //反序列化為動態物件中的屬性
            var jsonModel = JsonConvert.DeserializeObject<dynamic>(json);

            //定義一個List來新增屬性
            List<string> listName = new List<string>();

            //動態新增要修改的欄位
            foreach (PropertyInfo info in model.GetType().GetProperties())
            {
                //如果EF表中有實體物件，則排除，否則更新會報錯,保留列舉
                if ((info.PropertyType.IsClass && info.PropertyType == typeof(String)) || info.PropertyType.IsClass == false)
                {
                    //解決大小寫問題
                    foreach (var property in jsonModel)
                    {
                        if (info.Name.ToLower().Trim() == property.Name.ToLower().Trim())
                        {
                            listName.Add(info.Name);
                        }
                    }
                }
            }

            //轉換要修改的欄位為陣列
            string[] ProNames = string.Join(",", listName).Split(",");

            //尋找主鍵
            PropertyInfo pkProp = typeof(T).GetProperties().Where(p => p.GetCustomAttributes(typeof(KeyAttribute), false).Length > 0).FirstOrDefault();

            //遍歷修改,並排除主鍵
            foreach (string Name in ProNames)
            {
                if (Name.ToLower() != pkProp.Name.ToLower())
                {
                    _context.Entry(model).Property(Name).IsModified = true;
                }
            }

            //return db.SaveChanges();
        }

        /// <summary>
        /// 更新指定實體,不更新指定欄位
        /// </summary>
        /// <typeparam name="T">資料表實體Model模型</typeparam>
        /// <param name="modelNew">動態Json資料</param>
        /// <param name="fieldProNames">不更新的欄位列表陣列</param>
        protected virtual void Update<T>(dynamic modelNew, string fieldProNames)
        {
            //序列化動態Json為字串
            string json = modelNew.ToString();

            //反序列化為資料表中的實體物件
            T model = JsonConvert.DeserializeObject<T>(json);

            //把狀態全部變為不可更改
            _context.Entry(model).State = EntityState.Unchanged;

            //反序列化為動態物件中的屬性
            var jsonModel = JsonConvert.DeserializeObject<dynamic>(json);

            //定義一個List來新增屬性
            List<string> listName = new List<string>();

            //動態新增要修改的欄位
            foreach (PropertyInfo info in model.GetType().GetProperties())
            {
                //如果EF表中有實體物件，則排除，否則更新會報錯,保留列舉
                if ((info.PropertyType.IsClass && info.PropertyType == typeof(String)) || info.PropertyType.IsClass == false)
                {
                    //解決大小寫問題
                    foreach (var property in jsonModel)
                    {
                        if (info.Name.ToLower().Trim() == property.Name.ToLower().Trim())
                        {
                            listName.Add(info.Name);
                        }
                    }
                }
            }

            //轉換要修改的欄位為陣列
            string[] ProNames = string.Join(",", listName).Split(",");

            //尋找主鍵
            PropertyInfo pkProp = typeof(T).GetProperties().Where(p => p.GetCustomAttributes(typeof(KeyAttribute), false).Length > 0).FirstOrDefault();

            //遍歷修改,並排除主鍵
            foreach (string Name in ProNames)
            {
                if (Name.ToLower() != pkProp.Name.ToLower() && !fieldProNames.Split(",").Select(n => n.ToLower()).Contains(Name.ToLower()))
                {
                    _context.Entry(model).Property(Name).IsModified = true;
                }
            }

            //return db.SaveChanges();
        }

        /// <summary>
        /// 更新指定實體,不更新指定欄位,如果每個表中有相同不更新的欄位，可以這樣寫
        /// </summary>
        /// <typeparam name="T">資料表實體Model模型</typeparam>
        /// <param name="modelNew">動態Json資料</param>
        protected virtual void UpdateSpecify<T>(dynamic modelNew)
        {
            //序列化動態Json為字串
            string json = modelNew.ToString();

            //反序列化為資料表中的實體物件
            T model = JsonConvert.DeserializeObject<T>(json);

            //把狀態全部變為不可更改
            _context.Entry(model).State = EntityState.Unchanged;

            //反序列化為動態物件中的屬性
            var jsonModel = JsonConvert.DeserializeObject<dynamic>(json);

            //定義一個List來新增屬性
            List<string> listName = new List<string>();

            //定義不需要更新的欄位
            string fieldProNames = "field1,field2,field3,CreateDate,Creator,IsDel,Updator,UpdateDate";

            //動態新增要修改的欄位
            foreach (PropertyInfo info in model.GetType().GetProperties())
            {
                //如果EF表中有實體物件，則排除，否則更新會報錯,保留列舉
                if ((info.PropertyType.IsClass && info.PropertyType == typeof(String)) || info.PropertyType.IsClass == false)
                {
                    //解決大小寫問題
                    foreach (var property in jsonModel && !fieldProNames.Split(",").Select(n => n.ToLower()).Contains(info.Name.ToLower()))
                    {
                        if (info.Name.ToLower().Trim() == property.Name.ToLower().Trim())
                        {
                            listName.Add(info.Name);
                        }
                    }
                }
            }

            //轉換要修改的欄位為陣列
            string[] ProNames = string.Join(",", listName).Split(",");

            //尋找主鍵
            PropertyInfo pkProp = typeof(T).GetProperties().Where(p => p.GetCustomAttributes(typeof(KeyAttribute), false).Length > 0).FirstOrDefault();

            //遍歷修改,並排除主鍵
            foreach (string Name in ProNames)
            {
                if (Name.ToLower() != pkProp.Name.ToLower())
                {
                    _context.Entry(model).Property(Name).IsModified = true;
                }
            }

            //return db.SaveChanges();
        }

        /// <summary>
        /// 更新指定實體,不更新指定欄位,如果每個表中有相同不更新的欄位，可以這樣寫,擴充套件方法
        /// </summary>
        /// <typeparam name="T">資料表實體Model模型</typeparam>
        /// <param name="modelNew">動態Json資料</param>
        /// <param name="fieldProNames">不更新的欄位列表陣列</param>
        protected virtual void UpdateSpecify<T>(dynamic modelNew, string fieldProNames)
        {
            //序列化動態Json為字串
            string json = modelNew.ToString();

            //反序列化為資料表中的實體物件
            T model = JsonConvert.DeserializeObject<T>(json);

            //把狀態全部變為不可更改
            _context.Entry(model).State = EntityState.Unchanged;

            //反序列化為動態物件中的屬性
            var jsonModel = JsonConvert.DeserializeObject<dynamic>(json);

            //定義一個List來新增屬性
            List<string> listName = new List<string>();

            //定義不需要更新的欄位
            string fieldProNameses = "field1,field2,field3,CreateDate,Creator,IsDel,Updator,UpdateDate," + fieldProNames;

            //動態新增要修改的欄位
            foreach (PropertyInfo info in model.GetType().GetProperties())
            {
                //如果EF表中有實體物件，則排除，否則更新會報錯,保留列舉
                if ((info.PropertyType.IsClass && info.PropertyType == typeof(String)) || info.PropertyType.IsClass == false)
                {
                    //解決大小寫問題
                    foreach (var property in jsonModel && !fieldProNameses.Split(",").Select(n => n.ToLower()).Contains(info.Name.ToLower()))
                    {
                        if (info.Name.ToLower().Trim() == property.Name.ToLower().Trim())
                        {
                            listName.Add(info.Name);
                        }
                    }
                }
            }

            //轉換要修改的欄位為陣列
            string[] ProNames = string.Join(",", listName).Split(",");

            //尋找主鍵
            PropertyInfo pkProp = typeof(T).GetProperties().Where(p => p.GetCustomAttributes(typeof(KeyAttribute), false).Length > 0).FirstOrDefault();

            //遍歷修改,並排除主鍵
            foreach (string Name in ProNames)
            {
                if (Name.ToLower() != pkProp.Name.ToLower())
                {
                    _context.Entry(model).Property(Name).IsModified = true;
                }
            }

            //return db.SaveChanges();
        }
    }
}

利用泛型+反射新增動態修改資料表的方法完成之後去測試吧。新建個Controller

using Microsoft.AspNetCore.Mvc;
using System.Threading.Tasks;

namespace ASP.NET.Core.EF
{
    /// <summary>測試修改控制器</summary>
    [Route("api/[controller]")]
    [ApiController]
    public class DemoController : PageBase
    {
        /// <summary>建構函式</summary>
        /// <param name="context">依賴注入資料庫連線SQL</param>
        public DemoController(DBContext context) : base(context)
        {
        }

        /// <summary>測試修改資料</summary>
        /// <param name="modelModify">動態修改的Json實體</param>
        /// <returns></returns>
        [HttpPut]
        public async Task<IActionResult> PutModel(dynamic modelModify)
        {
            Update<MemberModel>(modelModify);
            Update<MemberModel>(modelModify, "testField1,testField2,testField3");
            UpdateSpecify<MemberModel>(modelModify);
            UpdateSpecify<MemberModel>(modelModify, "testField1,testField2,testField3");
            return Ok("修改成功，請查詢資料庫");
        }
    }
}

前端測試Json資料

{
    "id": 1,
    "testField1": "demo1",
    "testField2": "demo2",
    "testField3": "demo3",
}

好了，完功，這樣後端開發就很舒服了，可以說輕鬆加愉快，對於前端也很舒服！解脫了很多時間！！

.net core WebAPI+EF 動態接收前臺json，並動態修改資料庫

.net core WebAPI+EF 動態接收前臺json，並動態修改資料庫

.NET Core+WebApi+EF訪問資料新增使用者資料

Docker學習筆記之-部署.Net Core 3.1專案到Docker容器，並使用Nginx反向代理（CentOS7）(二)

asp.net core webapi 使用ef 對mysql進行增刪改查，並生成Docker鏡像構建容器運行

ASP.NET Core WebAPI 開啟靜態網頁,設定主頁,跨域,Json保持原始大小寫,新增MIME,解除大檔案上傳限制

.Net Core WebApi控制器接收原始請求正文內容

SAAS雲平臺搭建札記: (三) AntDesign + .Net Core WebAPI許可權控制、動態選單的生成

Asp.Net Core WebAPI入門整理（二）簡單示例

Asp.Net Core WebAPI入門整理（三）跨域處理

.net core webapi 部署windows server 2008 r2 筆記

asp.net core webapi 似乎未安裝在 IIS 中承載 .NET Core 項目所需的 AspNetCoreModule。請嘗試修復 Visual Studio 以糾正該問題。

LINUX 下Jexus部署ASP.NET Core WebApi

（3）.Net Core的EF Core的使用

.NET Core 通過 Ef Core 操作 Mysql

Global exception handling in asp.net core webapi

.NET Core webapi 發布到IIS配置文件

發布 .Net Core WebAPI 應用程序到 Docker

Cordova Upload Images using File Transfer Plugin and .Net core WebAPI

用Macbook開發桌面應用，使用Alamofire鏈接.Net Core Webapi的註意事項！

.NET Core WebApi中實現多態數據綁定

.net core WebAPI+EF 動態接收前臺json，並動態修改資料庫

相關推薦