XUCore.Template.FreeSql 7.9.7

There is a newer version of this package available.
See the version list below for details.
dotnet new install XUCore.Template.FreeSql::7.9.7                
This package contains a .NET Template Package you can call from the shell/command line.

XUCore.Template.FreeSql

XUCore.Template.FreeSql

基于 FreeSql 的精简分层快速开发项目模板,生成 WebApi 项目

使用模板

本地安装模板:可详情见 install-template.bat 文件内

本地安装模板步骤:

如果已经装过旧版,可以先执行下面命令进行卸载:


dotnet new -u xfreesql

然后安装指定版本:


dotnet new --install XUCore.Template.FreeSql::{version}

创建项目

切换到指定创建的目录。

假设我们需要在 E:\demo 创建,

那么先切换到该目录


cd E:\demo

然后执行下面命令创建项目


dotnet new xfreesql -n MyTest -o .

这里的 xfreesql 是使用模板短名称。

MyTest 为新创建的项目名称。

avatar

本地构建项目镜像到 Docker(如果使用 jenkins 可以直接在 jenkins 里配置)

前提是 dockerfile 需要放在项目根目录,而非启动项目的目录

不采用微软自带的 dockerfile,我们需要手工打包发布。

1、切换到项目目录


cd E:\demo\MyTest.WebApi2

2、本地编译


dotnet build -c Release

3、本地发布(实际发布到当前项目的 bin/Release/net5.0/publish/ 目录)


dotnet publish -c Release

4、打包进 docker


docker build -t mytest:0.0.1 .

从控制台中,我们可以看到打包过程


E:\MyTest>docker build -t mytest:0.0.1 .
[+] Building 14.7s (12/20)
 => [internal] load build definition from Dockerfile                                                               0.0s
 => => transferring dockerfile: 32B                                                                                0.0s
 => [internal] load .dockerignore                                                                                  0.0s
 => => transferring context: 2B                                                                                    0.0s
 => [internal] load metadata for mcr.microsoft.com/dotnet/sdk:5.0                                                  0.0s
[+] Building 15.1s (12/20)
 => [internal] load build definition from Dockerfile                                                               0.0s
[+] Building 30.4s (12/20)
 => [internal] load build definition from Dockerfile                                                               0.0s
 => => transferring dockerfile: 32B                                                                                0.0s
 => [internal] load .dockerignore                                                                                  0.0s
 => => transferring context: 2B                                                                                    0.0s
[+] Building 56.7s (21/21) FINISHED
 => [internal] load build definition from Dockerfile                                                               0.0s
 => => transferring dockerfile: 32B                                                                                0.0s
 => [internal] load .dockerignore                                                                                  0.0s
 => => transferring context: 2B                                                                                    0.0s
 => [internal] load metadata for mcr.microsoft.com/dotnet/sdk:5.0                                                  0.0s
 => [internal] load metadata for mcr.microsoft.com/dotnet/aspnet:5.0                                               0.0s
 => [build 1/7] FROM mcr.microsoft.com/dotnet/sdk:5.0                                                              0.0s
 => [internal] load build context                                                                                  1.2s
 => => transferring context: 119.91MB                                                                              1.2s
 => [base 1/5] FROM mcr.microsoft.com/dotnet/aspnet:5.0                                                            0.0s
 => CACHED [build 2/7] WORKDIR /src                                                                                0.0s
 => CACHED [build 3/7] COPY [MyTest.WebApi2/MyTest.WebApi2.csproj, MyTest.WebApi2/]                                   0.0s
 => CACHED [build 4/7] RUN dotnet restore "MyTest.WebApi2/MyTest.WebApi2.csproj"                                     0.0s
 => [build 5/7] COPY . .                                                                                           0.4s
 => [build 6/7] WORKDIR /src/MyTest.WebApi2                                                                         0.0s
 => [build 7/7] RUN dotnet build "MyTest.WebApi2.csproj" -c Release -o /app/build                                  43.2s
 => [publish 1/1] RUN dotnet publish "MyTest.WebApi2.csproj" -c Release -o /app/publish                            11.5s
 => CACHED [base 2/5] ADD [sources.list, /etc/apt/]                                                                0.0s
 => CACHED [base 3/5] RUN rm /etc/localtime                                                                        0.0s
 => CACHED [base 4/5] RUN ln -s /usr/share/zoneinfo/Asia/Shanghai /etc/localtime                                   0.0s
 => CACHED [base 5/5] WORKDIR /app                                                                                 0.0s
 => CACHED [final 1/2] WORKDIR /app                                                                                0.0s
 => CACHED [final 2/2] COPY --from=publish /app/publish .                                                          0.0s
 => exporting to image                                                                                             0.0s
 => => exporting layers                                                                                            0.0s
 => => writing image sha256:addb11051debc4cf74c7d048d15cafdb7edbf121ae54fc55960f1b46bce94fda                       0.0s
 => => naming to docker.io/library/mytest:0.0.1                                                                    0.0s
 => => #   Determining projects to restore...
Use 'docker scan' to run Snyk tests against images to find vulnerabilities and learn how to fix them

结束后,我们使用 docker images 查看打包好的镜像


E:\MyTest>docker images
REPOSITORY                        TAG       IMAGE ID       CREATED        SIZE
mytest                            0.0.1     addb11051deb   20 hours ago   258MB
mcr.microsoft.com/dotnet/sdk      5.0       1cfcb8589c29   12 days ago    631MB
mcr.microsoft.com/dotnet/aspnet   5.0       592a912e0dcb   12 days ago    205MB

3、启动容器


docker run --name my-test -d -p 8090:8090 mytest:0.0.1

启动后我们通过 docker ps -a 查看运行的镜像


E:\MyTest>docker ps -a
CONTAINER ID   IMAGE          COMMAND                  CREATED         STATUS                       PORTS     NAMES
35c9010404ae   mytest:0.0.1   "dotnet MyTest.WebAp…"   5 minutes ago   Exited (139) 4 minutes ago             my-test

4、浏览器访问

http://127.0.0.1:8090/swagger

此时容器会报错,因为在创建项目后配置文件内需要修改数据库连接地址(进入容器后,我们的所有数据库地址以及其他相关地址都需要修改为内网访问,或者公网访问)

我们可以查看容器的日志,方便我们定位错误


docker logs 35c9010404ae

此时,在容器日志,我们看到


fail: Microsoft.EntityFrameworkCore.Database.Connection[20004]
      An error occurred using the connection to database '' on server 'localhost'.
fail: Microsoft.EntityFrameworkCore.Database.Connection[20004]
      An error occurred using the connection to database '' on server 'localhost'.
fail: Microsoft.EntityFrameworkCore.Database.Connection[20004]
      An error occurred using the connection to database '' on server 'localhost'.
fail: Microsoft.EntityFrameworkCore.Database.Connection[20004]
      An error occurred using the connection to database '' on server 'localhost'.
fail: Microsoft.EntityFrameworkCore.Database.Connection[20004]
      An error occurred using the connection to database '' on server 'localhost'.
fail: Microsoft.EntityFrameworkCore.Database.Connection[20004]

客户端接入 API


API 隐藏操作说明
head value 说明
limit-mode contain or ignore contain 的意思是指定输出字段, ignore 的意思是忽略指定字段
limit-field 字段集合 指定要输出或要忽略的字段,以英文逗号分隔,如:column1,column2,column3
limit-field-rename 要重命名的字段 字段以输出为准,比如:code=c,subCode=sub,data=data,nickname=userNickName
limit-resolver camelcase or default camelcase 的意思是指定输出小驼峰字段, default 的意思是默认输出大小写字段
limit-date-unix true or false 当设置为true的时候 则是所有DateTime时间全部返回时间戳,当为false的时候不启用
limit-date-format 日期格式化字符串 比如:yyyy-MM-dd'T'HH:mm:ss'Z' 返回的数据如:2021-01-06T10:03:38Z
1、如何改变 DateTime 的格式?

我们需要在 http 请求的时候,在 head 里加入配置

head value 说明
limit-date-unix true or false 当设置为true的时候 则是所有DateTime时间全部返回时间戳,当为false的时候不启用
limit-date-format 日期格式化字符串 比如:yyyy-MM-dd'T'HH:mm:ss'Z' 返回的数据如:2021-01-06T10:03:38Z

注意: limit-date-unix的优先级要大于limit-date-format


2、如何重命名和指定输出需要的字段?
head value 说明
limit-mode contain or ignore contain 的意思是指定输出字段, ignore 的意思是忽略指定字段
limit-field 字段集合 指定要输出或要忽略的字段,以英文逗号分隔,如:column1,column2,column3
limit-field-rename 要重命名的字段 字段以输出为准,比如:code=c,subCode=sub,data=data,nickname=userNickName

注意:当你使用重命名limit-field-rename字段后,指定输出的字段limit-field要以重命名后的字段名为准,大小写也请依照你重命名后的格式。

任何指定输出,均不影响原始定义的结构。

3、如何指定输出小驼峰字段?
head value 说明
limit-resolver camelcase or default camelcase 的意思是指定输出小驼峰字段, default 的意思是默认输出大小写字段

任何指定输出,均不影响原始定义的结构。

示例一

如下表设置:

设置 说明
limit-mode contain 指定匹配输出模式
limit-field code,subCode,data,userId,userNickName,entName 设置需要的字段集合,英文逗号分隔

示例二

如下表设置:

设置 说明
limit-mode contain 指定匹配输出模式
limit-field code,sub,data,totalPages,totalRecords,pageDatas,createTime,nickName,entId,entName 设置需要的字段集合,英文逗号分隔,并以重命名后的字段为准设置输出字段
limit-field-rename subcode=sub,data=data,items=pageDatas,userNickName=nickName 重命名字段

示例三

如下表设置:

设置 说明
limit-mode ignore 指定忽略输出模式
limit-field code,subCode,message,userId,userNickName,entName,productType,userHeadImg_48 设置要忽略的字段集合,英文逗号分隔

示例四

如下表设置:

设置 说明
limit-mode ignore 指定忽略输出模式
limit-field code,subCode,message,userId,userNickName,entName,productType,userHeadImg_48 设置要忽略的字段集合,英文逗号分隔
limit-date-unix true 设置 DateTime 输出时间戳
Accept application/json 指定输出 json 格式的 json 字符串格式

适用范围定义

在一定程度上使 API 接入变得稍微复杂了一点点,但是能优化网络传输,或许我们可以考虑牺牲一点复杂度,按需索取来优化传输问题。

客户端 适合程度
移动端 非常适合
web 端 适合
服务端 跨语言,在不同规范的情况下适合接入,能解决模型不一致的问题,k8s 内走内网地址不需要考虑这个问题
  • net6.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
9.6.21 80 11/14/2024
9.6.19 78 11/14/2024
9.6.18 83 11/8/2024
9.6.17 86 10/31/2024
9.6.16 80 10/31/2024
9.6.15 79 10/31/2024
9.6.14 85 10/25/2024
9.6.13 85 10/25/2024
9.6.12 105 9/29/2024
9.6.11 100 9/26/2024
9.6.10 93 9/24/2024
9.6.9 83 9/24/2024
9.6.8 92 9/24/2024
9.6.7 87 9/23/2024
9.6.6 85 9/20/2024
9.6.5 106 9/14/2024
9.6.4 115 9/14/2024
9.6.3 128 8/21/2024
9.6.2 129 8/21/2024
9.6.1 130 8/13/2024
9.5.9 84 8/2/2024
9.5.8 87 8/1/2024
9.5.7 79 7/31/2024
9.5.6 78 7/26/2024
9.5.5 103 7/23/2024
9.5.4 101 7/23/2024
9.5.3 102 7/22/2024
9.5.2 96 7/18/2024
9.5.1 111 7/16/2024
9.4.11 100 7/11/2024
9.4.10 91 7/5/2024
9.4.9 119 7/2/2024
9.4.8 111 7/1/2024
9.4.7 117 6/27/2024
9.4.6 103 6/26/2024
9.4.5 110 6/25/2024
9.4.4 109 6/23/2024
9.4.3 106 6/21/2024
9.4.2 111 6/14/2024
9.4.1 105 6/14/2024
9.3.11 108 6/4/2024
9.3.10 112 6/4/2024
9.3.9 113 5/31/2024
9.3.8 142 5/28/2024
9.3.7 211 5/24/2024
9.3.6 119 5/23/2024
9.3.5 123 5/23/2024
9.3.4 138 5/22/2024
9.3.3 264 5/15/2024
9.3.2 133 5/15/2024
9.3.1 118 5/15/2024
9.2.19 120 5/14/2024
9.2.18 109 5/14/2024
9.2.17 100 5/14/2024
9.2.16 127 5/14/2024
9.2.15 126 5/13/2024
9.2.14 148 5/13/2024
9.2.13 96 5/13/2024
9.2.12 116 5/12/2024
9.2.11 176 5/11/2024
9.2.10 127 5/10/2024
9.2.9 139 5/9/2024
9.2.8 174 5/7/2024
9.2.7 147 5/7/2024
9.2.6 107 4/29/2024
9.2.5 121 4/25/2024
9.2.4 128 4/22/2024
9.2.3 111 4/19/2024
9.2.2 121 4/19/2024
9.2.1 115 4/17/2024
9.1.13 146 4/16/2024
9.1.12 120 4/16/2024
9.1.11 153 4/16/2024
9.1.10 155 4/14/2024
9.1.9 141 4/14/2024
9.1.8 154 4/12/2024
9.1.7 127 4/12/2024
9.1.6 157 4/12/2024
9.1.5 161 4/11/2024
9.1.4 129 4/11/2024
9.1.3 137 4/11/2024
9.1.2 133 4/10/2024
9.1.1 203 4/9/2024
8.11.12 134 4/9/2024
8.11.11 158 4/3/2024
8.11.10 168 3/29/2024
8.11.9 207 3/28/2024
8.11.8 221 3/26/2024
8.11.7 290 3/25/2024
8.11.6 354 3/21/2024
8.11.5 450 3/13/2024
8.11.4 304 3/10/2024
8.11.3 440 3/4/2024
8.11.2 336 3/4/2024
8.11.1 370 3/1/2024
8.10.14 572 2/21/2024
8.10.13 328 2/20/2024
8.10.12 380 2/20/2024
8.10.11 295 2/20/2024
8.10.10 331 2/20/2024
8.10.8 455 2/20/2024
8.10.7 341 2/18/2024
8.10.6 333 2/18/2024
8.10.5 695 2/6/2024
8.10.4 379 2/6/2024
8.10.3 443 2/4/2024
8.10.2 388 2/4/2024
8.10.1 566 2/4/2024
8.9.9 386 2/3/2024
8.9.8 329 2/3/2024
8.9.7 599 1/26/2024
8.9.6 347 1/26/2024
8.9.5 476 1/25/2024
8.9.4 416 1/25/2024
8.9.3 608 1/24/2024
8.9.2 501 1/23/2024
8.9.1 322 1/23/2024
8.9.0 402 1/23/2024
8.8.9 510 1/23/2024
8.8.8 492 1/22/2024
8.8.7 578 1/22/2024
8.8.6 400 1/22/2024
8.8.5 399 1/22/2024
8.8.4 334 1/22/2024
8.8.3 427 1/22/2024
8.8.2 458 1/20/2024
8.8.1 485 1/20/2024
8.8.0 450 1/20/2024
8.7.9 437 1/20/2024
8.7.8 511 1/20/2024
8.7.7 463 1/19/2024
8.7.6 471 1/19/2024
8.7.5 442 1/19/2024
8.7.4 459 1/19/2024
8.7.3 372 1/19/2024
8.7.2 403 1/19/2024
8.7.1 493 1/19/2024
8.7.0 424 1/18/2024
8.6.9 458 1/18/2024
8.6.8 397 1/18/2024
8.6.7 413 1/18/2024
8.6.6 471 1/18/2024
8.6.5 438 1/18/2024
8.6.4 434 1/17/2024
8.6.3 440 1/17/2024
8.6.2 525 1/17/2024
8.6.1 458 1/16/2024
8.6.0 473 1/16/2024
8.5.9 467 1/16/2024
8.5.8 446 1/15/2024
8.5.7 492 1/15/2024
8.5.6 592 1/15/2024
8.5.5 524 1/14/2024
8.5.4 516 1/14/2024
8.5.3 519 1/13/2024
8.5.2 445 1/13/2024
8.5.1 483 1/13/2024
8.5.0 511 1/12/2024
8.4.9 473 1/11/2024
8.4.8 584 1/11/2024
8.4.7 533 1/10/2024
8.4.6 619 1/10/2024
8.4.5 434 1/10/2024
8.4.4 542 1/9/2024
8.4.3 591 1/8/2024
8.4.2 598 1/8/2024
8.4.1 546 1/8/2024
8.4.0 409 1/8/2024
8.3.9 473 1/8/2024
8.3.8 491 1/8/2024
8.3.7 489 1/8/2024
8.3.6 604 1/6/2024
8.3.5 487 1/5/2024
8.3.4 533 1/5/2024
8.3.3 470 1/5/2024
8.3.2 428 1/5/2024
8.3.1 617 1/5/2024
8.3.0 467 1/5/2024
8.2.9 532 1/5/2024
8.2.8 636 1/4/2024
8.2.7 567 1/4/2024
8.2.6 493 1/4/2024
8.2.5 432 1/4/2024
8.2.4 540 1/3/2024
8.2.3 494 1/3/2024
8.2.2 653 1/3/2024
8.2.1 512 1/3/2024
8.2.0 490 1/2/2024
8.1.9 432 1/2/2024
8.1.8 765 12/25/2023
8.1.7 946 12/18/2023
8.1.6 676 12/15/2023
8.1.5 626 12/14/2023
8.1.4 692 12/14/2023
8.1.3 634 12/14/2023
8.1.2 657 12/14/2023
8.1.1 636 12/14/2023
8.1.0 716 12/13/2023
8.0.9 589 12/13/2023
8.0.8 516 12/13/2023
8.0.7 594 12/13/2023
8.0.6 767 12/12/2023
8.0.5 779 12/12/2023
8.0.4 800 12/11/2023
8.0.3 772 12/7/2023
8.0.2 669 12/6/2023
8.0.1 619 12/5/2023
8.0.0 514 12/5/2023
7.9.9 852 12/5/2023
7.9.8 739 12/5/2023
7.9.7 727 12/4/2023
7.9.6 579 12/4/2023
7.9.5 641 12/1/2023
7.9.4 918 11/24/2023
7.9.3 617 11/24/2023
7.9.2 789 11/23/2023
7.9.1 791 11/17/2023
7.9.0 617 11/17/2023
7.8.9 614 11/17/2023
7.8.8 673 11/16/2023
7.8.7 530 11/16/2023
7.8.6 660 11/16/2023
7.8.5 632 11/16/2023
7.8.4 577 11/15/2023
7.8.3 521 11/14/2023
7.8.2 623 11/10/2023
7.8.1 721 11/10/2023
7.8.0 690 11/10/2023
7.7.9 600 11/9/2023
7.7.8 543 11/9/2023
7.7.7 642 11/8/2023
7.7.6 597 11/8/2023
7.7.5 672 11/7/2023
7.7.4 646 11/7/2023
7.7.3 542 11/7/2023
7.7.2 595 11/7/2023
7.7.1 635 11/7/2023
7.7.0 743 11/3/2023
7.6.9 690 11/3/2023
7.6.8 746 11/3/2023
7.6.7 625 11/3/2023
7.6.6 717 11/2/2023
7.6.5 779 10/31/2023
7.6.4 647 10/31/2023
7.6.3 629 10/30/2023
7.6.2 755 10/27/2023
7.6.1 678 10/27/2023
7.6.0 688 10/27/2023
7.5.9 839 10/27/2023
7.5.8 711 10/27/2023
7.5.7 693 10/26/2023
7.5.6 730 10/26/2023
7.5.5 749 10/26/2023
7.5.4 546 10/26/2023
7.5.3 750 10/25/2023
7.5.2 674 10/25/2023
7.5.1 784 10/25/2023
7.5.0 808 10/24/2023
7.4.9 696 10/24/2023
7.4.8 794 10/24/2023
7.4.7 716 10/23/2023
7.4.6 800 10/20/2023
7.4.5 794 10/20/2023
7.4.4 641 10/18/2023
7.4.3 965 10/9/2023
7.4.2 572 10/8/2023
7.4.1 882 10/7/2023
7.4.0 787 9/15/2023
7.3.9 675 9/15/2023
7.3.8 701 9/14/2023
7.3.7 626 9/14/2023
7.3.6 752 9/14/2023
7.3.5 863 9/13/2023
7.3.4 725 9/13/2023
7.3.3 698 9/13/2023
7.3.2 601 9/12/2023
7.3.1 766 9/12/2023
7.3.0 819 9/12/2023
7.2.9 832 9/7/2023
7.2.8 761 9/7/2023
7.2.7 623 9/6/2023
7.2.6 758 9/6/2023
7.2.5 829 9/6/2023
7.2.4 775 8/31/2023
7.2.3 798 8/31/2023
7.2.2 694 8/30/2023
7.2.1 759 8/30/2023
7.2.0 810 8/30/2023
7.1.9 806 8/29/2023
7.1.8 737 8/29/2023
7.1.7 731 8/29/2023
7.1.6 682 8/29/2023
7.1.5 921 8/28/2023
7.1.4 846 8/28/2023
7.1.3 693 8/28/2023
7.1.2 814 8/25/2023
7.1.1 830 8/25/2023
7.1.0 725 8/25/2023
7.0.9 753 8/25/2023
7.0.8 573 8/24/2023
7.0.7 688 8/24/2023
7.0.6 792 8/24/2023
7.0.5 837 8/24/2023
7.0.4 718 8/23/2023
6.9.18 946 8/22/2023
6.9.17 853 8/22/2023
6.9.16 772 8/22/2023
6.9.15 802 8/22/2023
6.9.14 871 8/22/2023
6.9.13 776 8/22/2023
6.9.12 771 8/20/2023
6.9.11 778 8/19/2023
6.9.10 667 8/19/2023
6.9.9 887 8/19/2023