XUCore.Template.FreeSql 9.3.5

There is a newer version of this package available.
See the version list below for details.
dotnet new install XUCore.Template.FreeSql::9.3.5
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.4.2 33 6/14/2024
9.4.1 37 6/14/2024
9.3.11 69 6/4/2024
9.3.10 72 6/4/2024
9.3.9 73 5/31/2024
9.3.8 105 5/28/2024
9.3.7 179 5/24/2024
9.3.6 82 5/23/2024
9.3.5 87 5/23/2024
9.3.4 100 5/22/2024
9.3.3 229 5/15/2024
9.3.2 88 5/15/2024
9.3.1 85 5/15/2024
9.2.19 88 5/14/2024
9.2.18 77 5/14/2024
9.2.17 65 5/14/2024
9.2.16 87 5/14/2024
9.2.15 90 5/13/2024
9.2.14 75 5/13/2024
9.2.13 67 5/13/2024
9.2.12 77 5/12/2024
9.2.11 117 5/11/2024
9.2.10 96 5/10/2024
9.2.9 99 5/9/2024
9.2.8 122 5/7/2024
9.2.7 115 5/7/2024
9.2.6 82 4/29/2024
9.2.5 87 4/25/2024
9.2.4 88 4/22/2024
9.2.3 82 4/19/2024
9.2.2 87 4/19/2024
9.2.1 83 4/17/2024
9.1.13 115 4/16/2024
9.1.12 88 4/16/2024
9.1.11 107 4/16/2024
9.1.10 119 4/14/2024
9.1.9 113 4/14/2024
9.1.8 107 4/12/2024
9.1.7 93 4/12/2024
9.1.6 106 4/12/2024
9.1.5 133 4/11/2024
9.1.4 101 4/11/2024
9.1.3 102 4/11/2024
9.1.2 99 4/10/2024
9.1.1 169 4/9/2024
8.11.12 100 4/9/2024
8.11.11 127 4/3/2024
8.11.10 133 3/29/2024
8.11.9 176 3/28/2024
8.11.8 184 3/26/2024
8.11.7 259 3/25/2024
8.11.6 321 3/21/2024
8.11.5 417 3/13/2024
8.11.4 266 3/10/2024
8.11.3 404 3/4/2024
8.11.2 305 3/4/2024
8.11.1 340 3/1/2024
8.10.14 535 2/21/2024
8.10.13 293 2/20/2024
8.10.12 336 2/20/2024
8.10.11 257 2/20/2024
8.10.10 296 2/20/2024
8.10.8 425 2/20/2024
8.10.7 302 2/18/2024
8.10.6 303 2/18/2024
8.10.5 660 2/6/2024
8.10.4 335 2/6/2024
8.10.3 388 2/4/2024
8.10.2 359 2/4/2024
8.10.1 504 2/4/2024
8.9.9 330 2/3/2024
8.9.8 296 2/3/2024
8.9.7 546 1/26/2024
8.9.6 312 1/26/2024
8.9.5 445 1/25/2024
8.9.4 378 1/25/2024
8.9.3 575 1/24/2024
8.9.2 465 1/23/2024
8.9.1 292 1/23/2024
8.9.0 368 1/23/2024
8.8.9 478 1/23/2024
8.8.8 463 1/22/2024
8.8.7 537 1/22/2024
8.8.6 366 1/22/2024
8.8.5 362 1/22/2024
8.8.4 297 1/22/2024
8.8.3 396 1/22/2024
8.8.2 430 1/20/2024
8.8.1 452 1/20/2024
8.8.0 413 1/20/2024
8.7.9 406 1/20/2024
8.7.8 461 1/20/2024
8.7.7 431 1/19/2024
8.7.6 437 1/19/2024
8.7.5 411 1/19/2024
8.7.4 422 1/19/2024
8.7.3 308 1/19/2024
8.7.2 375 1/19/2024
8.7.1 448 1/19/2024
8.7.0 385 1/18/2024
8.6.9 419 1/18/2024
8.6.8 363 1/18/2024
8.6.7 377 1/18/2024
8.6.6 434 1/18/2024
8.6.5 403 1/18/2024
8.6.4 402 1/17/2024
8.6.3 402 1/17/2024
8.6.2 496 1/17/2024
8.6.1 426 1/16/2024
8.6.0 439 1/16/2024
8.5.9 427 1/16/2024
8.5.8 411 1/15/2024
8.5.7 455 1/15/2024
8.5.6 557 1/15/2024
8.5.5 489 1/14/2024
8.5.4 487 1/14/2024
8.5.3 482 1/13/2024
8.5.2 408 1/13/2024
8.5.1 449 1/13/2024
8.5.0 476 1/12/2024
8.4.9 443 1/11/2024
8.4.8 551 1/11/2024
8.4.7 501 1/10/2024
8.4.6 584 1/10/2024
8.4.5 382 1/10/2024
8.4.4 506 1/9/2024
8.4.3 558 1/8/2024
8.4.2 566 1/8/2024
8.4.1 510 1/8/2024
8.4.0 376 1/8/2024
8.3.9 439 1/8/2024
8.3.8 464 1/8/2024
8.3.7 455 1/8/2024
8.3.6 570 1/6/2024
8.3.5 459 1/5/2024
8.3.4 498 1/5/2024
8.3.3 437 1/5/2024
8.3.2 395 1/5/2024
8.3.1 564 1/5/2024
8.3.0 432 1/5/2024
8.2.9 495 1/5/2024
8.2.8 607 1/4/2024
8.2.7 532 1/4/2024
8.2.6 467 1/4/2024
8.2.5 398 1/4/2024
8.2.4 500 1/3/2024
8.2.3 456 1/3/2024
8.2.2 616 1/3/2024
8.2.1 484 1/3/2024
8.2.0 438 1/2/2024
8.1.9 404 1/2/2024
8.1.8 738 12/25/2023
8.1.7 900 12/18/2023
8.1.6 647 12/15/2023
8.1.5 600 12/14/2023
8.1.4 644 12/14/2023
8.1.3 593 12/14/2023
8.1.2 628 12/14/2023
8.1.1 601 12/14/2023
8.1.0 684 12/13/2023
8.0.9 557 12/13/2023
8.0.8 487 12/13/2023
8.0.7 561 12/13/2023
8.0.6 732 12/12/2023
8.0.5 749 12/12/2023
8.0.4 765 12/11/2023
8.0.3 739 12/7/2023
8.0.2 635 12/6/2023
8.0.1 584 12/5/2023
8.0.0 481 12/5/2023
7.9.9 824 12/5/2023
7.9.8 713 12/5/2023
7.9.7 691 12/4/2023
7.9.6 544 12/4/2023
7.9.5 616 12/1/2023
7.9.4 887 11/24/2023
7.9.3 581 11/24/2023
7.9.2 754 11/23/2023
7.9.1 759 11/17/2023
7.9.0 583 11/17/2023
7.8.9 582 11/17/2023
7.8.8 638 11/16/2023
7.8.7 493 11/16/2023
7.8.6 628 11/16/2023
7.8.5 578 11/16/2023
7.8.4 547 11/15/2023
7.8.3 492 11/14/2023
7.8.2 589 11/10/2023
7.8.1 693 11/10/2023
7.8.0 653 11/10/2023
7.7.9 568 11/9/2023
7.7.8 508 11/9/2023
7.7.7 608 11/8/2023
7.7.6 559 11/8/2023
7.7.5 640 11/7/2023
7.7.4 619 11/7/2023
7.7.3 511 11/7/2023
7.7.2 555 11/7/2023
7.7.1 597 11/7/2023
7.7.0 710 11/3/2023
7.6.9 658 11/3/2023
7.6.8 713 11/3/2023
7.6.7 592 11/3/2023
7.6.6 686 11/2/2023
7.6.5 746 10/31/2023
7.6.4 614 10/31/2023
7.6.3 595 10/30/2023
7.6.2 719 10/27/2023
7.6.1 645 10/27/2023
7.6.0 657 10/27/2023
7.5.9 810 10/27/2023
7.5.8 676 10/27/2023
7.5.7 659 10/26/2023
7.5.6 702 10/26/2023
7.5.5 702 10/26/2023
7.5.4 511 10/26/2023
7.5.3 720 10/25/2023
7.5.2 642 10/25/2023
7.5.1 758 10/25/2023
7.5.0 764 10/24/2023
7.4.9 665 10/24/2023
7.4.8 760 10/24/2023
7.4.7 683 10/23/2023
7.4.6 763 10/20/2023
7.4.5 759 10/20/2023
7.4.4 603 10/18/2023
7.4.3 939 10/9/2023
7.4.2 543 10/8/2023
7.4.1 813 10/7/2023
7.4.0 740 9/15/2023
7.3.9 642 9/15/2023
7.3.8 663 9/14/2023
7.3.7 594 9/14/2023
7.3.6 711 9/14/2023
7.3.5 822 9/13/2023
7.3.4 698 9/13/2023
7.3.3 665 9/13/2023
7.3.2 567 9/12/2023
7.3.1 734 9/12/2023
7.3.0 783 9/12/2023
7.2.9 799 9/7/2023
7.2.8 729 9/7/2023
7.2.7 590 9/6/2023
7.2.6 725 9/6/2023
7.2.5 796 9/6/2023
7.2.4 743 8/31/2023
7.2.3 768 8/31/2023
7.2.2 648 8/30/2023
7.2.1 725 8/30/2023
7.2.0 777 8/30/2023
7.1.9 777 8/29/2023
7.1.8 709 8/29/2023
7.1.7 671 8/29/2023
7.1.6 657 8/29/2023
7.1.5 894 8/28/2023
7.1.4 805 8/28/2023
7.1.3 665 8/28/2023
7.1.2 785 8/25/2023
7.1.1 798 8/25/2023
7.1.0 695 8/25/2023
7.0.9 723 8/25/2023
7.0.8 540 8/24/2023
7.0.7 659 8/24/2023
7.0.6 758 8/24/2023
7.0.5 808 8/24/2023
7.0.4 688 8/23/2023
6.9.18 920 8/22/2023
6.9.17 812 8/22/2023
6.9.16 740 8/22/2023
6.9.15 779 8/22/2023
6.9.14 835 8/22/2023
6.9.13 745 8/22/2023
6.9.12 738 8/20/2023
6.9.11 750 8/19/2023
6.9.10 636 8/19/2023
6.9.9 860 8/19/2023