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

時間 2020-03-14

標籤 core webapi+ef webapi 動態接收前臺 json 修改數據庫欄目 JavaScript 简体版

原文原文鏈接

用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，前臺也不須要把表全部的字段都傳過來，只須要傳頁面表單有的字段，也就是修改過的字段，靈活性大大提升，並且提升了開發效率。好了，不廢話了。開始正題。json

因爲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");
        }

跨域問題解決以後，添加動態修改數據庫的方法。api

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",
}

好了，完功，這樣後端開發就很舒服了，能夠說輕鬆加愉快，對於前端也很舒服！解脫了不少時間！！app

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。