.NET ORM框架HiSql實戰-第三章-使用自定義編號生成【申請編號】

一、引言

上一篇.NET ORM框架HiSql實戰-第二章-使用Hisql實現選單管理(增刪改查) 中選單編號採用的是雪花ID，生成的編號無法自定義。比如本系統的一個申請業務，需要按字首+日期+流水號的規則生成【申請編號】，這樣就可以用到hisql的自定義編號。

hisql自定義編號不但可以生成雪花ID,很重要的是支援類似以下規則的編號：
規則1：20220001、202200001....到202299999 或到 2022ZZZZZ。
規則2：BH20220708000001、BH20220708000001....到BH20220708999999 或到 BH20220708zZZZZZ。
規則...

您也可以通過檢視 Hisql流水編號 的各個引數的說明，解鎖更多的編號規則，實現您想要的編號。

先看結果圖：

二、使用步驟
1、 在檔案第一章中的檔案： HiSqlSetupExtension 加入編號物件的注入，這裡必須是採用單例模式注入

using HiSql;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using System;

namespace H.CRM.Action.API.Helper
{

    public static class HiSqlSetupExtension
    {
        public static IServiceCollection AddHiSqlSetup(this IServiceCollection services)
        {
            //注入HiSqlConfig
            services.AddTransient<HiSqlConfig>();
            //注入HiSqlClient
            services.AddTransient<HiSqlClient>((d) =>
            {
                var config = d.GetService<HiSqlConfig>();
                var hisql = new HiSqlClient(config);
                return hisql;
            });

            services.AddSingleton((d) =>
            {
                #region 叢集模式部署需要開啟Redis
                HiSql.Global.RedisOn = true;//開啟redis快取
                HiSql.Global.RedisOptions = new RedisOptions { Host = "127.0.0.1", PassWord = "", Port = 6379, CacheRegion = "HISQL" };
                HiSql.Global.NumberOptions.MultiMode = true;
                #endregion

                HiSql.Global.SnroOn = true;
                var config = d.GetService<HiSqlConfig>();
                HiSqlClient sqlClient = new HiSqlClient(config);
                sqlClient.CodeFirst.InstallHisql();
                var number = new SeriNumber(sqlClient);

                return number;
            });

            return services;
        }
    }

    class HiSqlConfig : ConnectionConfig
    {
        static readonly NLog.Logger logger = NLog.LogManager.GetLogger("HiSqlSetup");
        public HiSqlConfig(IConfiguration configuration)
        {
            DbType = DBType.SqlServer;
            DbServer = "HISQL";
            ConnectionString = configuration.GetSection("ConnectionStrings:Admin").Value;
            Schema = "dbo";
            SqlExecTimeOut = 1000 * 5;
            AppEvents = new AopEvent()
            {
                OnDbDecryptEvent = (connstr) =>
                {
                    //解密連線欄位
                    return connstr;
                },
                OnLogSqlExecuting = (sql, param) =>
                {
                    //sql執行前 紀錄檔記錄 (非同步)
#if DEBUG
                    logger.Trace($"執行前sql:{sql} time:{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss ffff")}");
#endif
                },
                OnLogSqlExecuted = (sql, param) =>
                {
#if DEBUG
                    //sql執行後 紀錄檔記錄 (非同步)
                    logger.Trace($"執行後sql：{sql} time:{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss ffff")}");
#endif
                },
                OnSqlError = (sqlEx) =>
                {
                    //sql執行錯誤後 紀錄檔記錄 (非同步)
                    logger.Error($"執行錯誤：{sqlEx.Message} sql:{sqlEx.Sql} time:{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss ffff")}");
                },
                OnTimeOut = (int timer) =>
                {
                    //logger.Trace($"執行超時：{timer} time:{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss ffff")}");
                }
            };
        }
    }
}

2、 設定編號服務。
在 HiSqlController 檔案新增Action ConfigSNRO(), 然後在存取改地址，就完成編號的初始化。這個設定只有修改編號規則的時候初始化一次，也可以採用其他方式初始化。

using Microsoft.AspNetCore.Mvc;
using HiSql;
using System.Linq;
using System.Collections.Generic;
using HSMB.Model.Dto;

namespace HSMB.Admin.WebApi.Controllers
{
    [Verify]
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class HiSqlController : ControllerBase
    {
        private readonly HiSqlClient sqlClient;
        private readonly SeriNumber seriNumber;

        
        public HiSqlController(
             HiSqlClient hiSqlClient
            , SeriNumber seriNumber
            )
        {
            this.sqlClient = hiSqlClient;
            this.seriNumber = seriNumber;
        }
        [HttpGet, HttpPost]
        public IActionResult Install()
        {
            HiSql.Global.SnroOn = true; //啟用編號。
            sqlClient.CodeFirst.InstallHisql();
            var tables = sqlClient.DbFirst.GetTables().ToList().Where(t => t.TabName.StartsWith("H"));
            return new JsonResult(tables);
        }

        [HttpGet, HttpPost]
        public IActionResult ConfigSNRO()
        {
            //設定表   "bus_request_person"  欄位 "reqID" 使用 自定義編號,名稱：request_person:
            ConfigSnroInit(new Hi_Snro()
            {
                SNRO = BillNumberType.request_person, // public const string request_person = "request_person";
                SNUM = 1,
                IsSnow = false,
                SnowTick = 0,
                StartNum = "0000",
                EndNum = "9999",
                Length = 4,
                CurrNum = "0000",
                CurrAllNum = "",
                PreChar = "",
                IsNumber = true,
                PreType = PreType.YM,
                FixPreChar = "P",
                IsHasPre = true,
                CacheSpace = 10,
                Descript = "申請單號"
            }, "bus_request_person", "reqID");
            return new JsonResult(true);
        }

        private void ConfigSnroInit(Hi_Snro snro, string tableName, string fieldName)
        {
            ///設定加入到編號表
            var cnt = sqlClient.Modi("Hi_Snro", snro).ExecCommand();
            //
            var json = sqlClient.Context.DMInitalize.GetTabStruct(tableName); //獲取一下表表機構，系統自動將表結構資訊插入到  Hi_FieldModel 中
            // 修改  Hi_FieldModel 中設定，
            sqlClient.Update(typeof(Hi_FieldModel).Name, new { TabName = tableName, FieldName = fieldName, SNO = snro.SNRO, SNO_NUM = snro.SNUM }).Only("SNO", "SNO_NUM").ExecCommand();
        }
        [HttpGet, HttpPost]
        public IActionResult TestSNRO(string SNRO = BillNumberType.request_person, int SNO_NUM = 1)
        {
            var num = seriNumber.NewNumber(SNRO, SNO_NUM);           
            return new JsonResult(num);
        }
       

    }
}

啟動專案通過測試程式碼可以看到編號沒問題；

3、修改 BusrequestpersonController 程式碼，將生成【申請編號】的地方採用 SeriNumber物件生成。
注入物件：

採用 SeriNumber物件生成編號：

完成後，啟用專案填寫業務申請，可以看到生成的編號如開頭的截圖一樣，是按照我們想要的規則生成編號的。