XUCore.Template.FreeSql
9.1.2
See the version list below for details.
dotnet new install XUCore.Template.FreeSql::9.1.2
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
为新创建的项目名称。
本地构建项目镜像到 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、浏览器访问
此时容器会报错,因为在创建项目后配置文件内需要修改数据库连接地址(进入容器后,我们的所有数据库地址以及其他相关地址都需要修改为内网访问,或者公网访问)
我们可以查看容器的日志,方便我们定位错误
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.3.4 | 0 | 5/22/2024 |
9.3.3 | 210 | 5/15/2024 |
9.3.2 | 82 | 5/15/2024 |
9.3.1 | 78 | 5/15/2024 |
9.2.19 | 82 | 5/14/2024 |
9.2.18 | 71 | 5/14/2024 |
9.2.17 | 58 | 5/14/2024 |
9.2.16 | 81 | 5/14/2024 |
9.2.15 | 84 | 5/13/2024 |
9.2.14 | 69 | 5/13/2024 |
9.2.13 | 60 | 5/13/2024 |
9.2.12 | 70 | 5/12/2024 |
9.2.11 | 109 | 5/11/2024 |
9.2.10 | 90 | 5/10/2024 |
9.2.9 | 93 | 5/9/2024 |
9.2.8 | 115 | 5/7/2024 |
9.2.7 | 110 | 5/7/2024 |
9.2.6 | 76 | 4/29/2024 |
9.2.5 | 83 | 4/25/2024 |
9.2.4 | 86 | 4/22/2024 |
9.2.3 | 81 | 4/19/2024 |
9.2.2 | 86 | 4/19/2024 |
9.2.1 | 82 | 4/17/2024 |
9.1.13 | 114 | 4/16/2024 |
9.1.12 | 87 | 4/16/2024 |
9.1.11 | 106 | 4/16/2024 |
9.1.10 | 118 | 4/14/2024 |
9.1.9 | 111 | 4/14/2024 |
9.1.8 | 105 | 4/12/2024 |
9.1.7 | 91 | 4/12/2024 |
9.1.6 | 104 | 4/12/2024 |
9.1.5 | 132 | 4/11/2024 |
9.1.4 | 100 | 4/11/2024 |
9.1.3 | 101 | 4/11/2024 |
9.1.2 | 98 | 4/10/2024 |
9.1.1 | 167 | 4/9/2024 |
8.11.12 | 98 | 4/9/2024 |
8.11.11 | 125 | 4/3/2024 |
8.11.10 | 131 | 3/29/2024 |
8.11.9 | 175 | 3/28/2024 |
8.11.8 | 183 | 3/26/2024 |
8.11.7 | 249 | 3/25/2024 |
8.11.6 | 319 | 3/21/2024 |
8.11.5 | 416 | 3/13/2024 |
8.11.4 | 265 | 3/10/2024 |
8.11.3 | 403 | 3/4/2024 |
8.11.2 | 304 | 3/4/2024 |
8.11.1 | 338 | 3/1/2024 |
8.10.14 | 532 | 2/21/2024 |
8.10.13 | 292 | 2/20/2024 |
8.10.12 | 327 | 2/20/2024 |
8.10.11 | 255 | 2/20/2024 |
8.10.10 | 295 | 2/20/2024 |
8.10.8 | 424 | 2/20/2024 |
8.10.7 | 301 | 2/18/2024 |
8.10.6 | 302 | 2/18/2024 |
8.10.5 | 656 | 2/6/2024 |
8.10.4 | 334 | 2/6/2024 |
8.10.3 | 387 | 2/4/2024 |
8.10.2 | 358 | 2/4/2024 |
8.10.1 | 502 | 2/4/2024 |
8.9.9 | 329 | 2/3/2024 |
8.9.8 | 295 | 2/3/2024 |
8.9.7 | 545 | 1/26/2024 |
8.9.6 | 311 | 1/26/2024 |
8.9.5 | 444 | 1/25/2024 |
8.9.4 | 369 | 1/25/2024 |
8.9.3 | 574 | 1/24/2024 |
8.9.2 | 464 | 1/23/2024 |
8.9.1 | 291 | 1/23/2024 |
8.9.0 | 367 | 1/23/2024 |
8.8.9 | 477 | 1/23/2024 |
8.8.8 | 462 | 1/22/2024 |
8.8.7 | 536 | 1/22/2024 |
8.8.6 | 365 | 1/22/2024 |
8.8.5 | 361 | 1/22/2024 |
8.8.4 | 296 | 1/22/2024 |
8.8.3 | 395 | 1/22/2024 |
8.8.2 | 429 | 1/20/2024 |
8.8.1 | 451 | 1/20/2024 |
8.8.0 | 412 | 1/20/2024 |
8.7.9 | 405 | 1/20/2024 |
8.7.8 | 460 | 1/20/2024 |
8.7.7 | 422 | 1/19/2024 |
8.7.6 | 436 | 1/19/2024 |
8.7.5 | 410 | 1/19/2024 |
8.7.4 | 421 | 1/19/2024 |
8.7.3 | 307 | 1/19/2024 |
8.7.2 | 374 | 1/19/2024 |
8.7.1 | 447 | 1/19/2024 |
8.7.0 | 384 | 1/18/2024 |
8.6.9 | 418 | 1/18/2024 |
8.6.8 | 362 | 1/18/2024 |
8.6.7 | 376 | 1/18/2024 |
8.6.6 | 433 | 1/18/2024 |
8.6.5 | 402 | 1/18/2024 |
8.6.4 | 401 | 1/17/2024 |
8.6.3 | 401 | 1/17/2024 |
8.6.2 | 495 | 1/17/2024 |
8.6.1 | 425 | 1/16/2024 |
8.6.0 | 438 | 1/16/2024 |
8.5.9 | 426 | 1/16/2024 |
8.5.8 | 410 | 1/15/2024 |
8.5.7 | 454 | 1/15/2024 |
8.5.6 | 556 | 1/15/2024 |
8.5.5 | 487 | 1/14/2024 |
8.5.4 | 486 | 1/14/2024 |
8.5.3 | 480 | 1/13/2024 |
8.5.2 | 407 | 1/13/2024 |
8.5.1 | 448 | 1/13/2024 |
8.5.0 | 475 | 1/12/2024 |
8.4.9 | 442 | 1/11/2024 |
8.4.8 | 550 | 1/11/2024 |
8.4.7 | 499 | 1/10/2024 |
8.4.6 | 583 | 1/10/2024 |
8.4.5 | 380 | 1/10/2024 |
8.4.4 | 504 | 1/9/2024 |
8.4.3 | 557 | 1/8/2024 |
8.4.2 | 564 | 1/8/2024 |
8.4.1 | 509 | 1/8/2024 |
8.4.0 | 375 | 1/8/2024 |
8.3.9 | 438 | 1/8/2024 |
8.3.8 | 463 | 1/8/2024 |
8.3.7 | 454 | 1/8/2024 |
8.3.6 | 569 | 1/6/2024 |
8.3.5 | 457 | 1/5/2024 |
8.3.4 | 497 | 1/5/2024 |
8.3.3 | 436 | 1/5/2024 |
8.3.2 | 394 | 1/5/2024 |
8.3.1 | 563 | 1/5/2024 |
8.3.0 | 431 | 1/5/2024 |
8.2.9 | 494 | 1/5/2024 |
8.2.8 | 606 | 1/4/2024 |
8.2.7 | 531 | 1/4/2024 |
8.2.6 | 466 | 1/4/2024 |
8.2.5 | 397 | 1/4/2024 |
8.2.4 | 499 | 1/3/2024 |
8.2.3 | 455 | 1/3/2024 |
8.2.2 | 615 | 1/3/2024 |
8.2.1 | 483 | 1/3/2024 |
8.2.0 | 437 | 1/2/2024 |
8.1.9 | 403 | 1/2/2024 |
8.1.8 | 737 | 12/25/2023 |
8.1.7 | 897 | 12/18/2023 |
8.1.6 | 645 | 12/15/2023 |
8.1.5 | 599 | 12/14/2023 |
8.1.4 | 643 | 12/14/2023 |
8.1.3 | 592 | 12/14/2023 |
8.1.2 | 627 | 12/14/2023 |
8.1.1 | 600 | 12/14/2023 |
8.1.0 | 683 | 12/13/2023 |
8.0.9 | 555 | 12/13/2023 |
8.0.8 | 486 | 12/13/2023 |
8.0.7 | 560 | 12/13/2023 |
8.0.6 | 731 | 12/12/2023 |
8.0.5 | 748 | 12/12/2023 |
8.0.4 | 764 | 12/11/2023 |
8.0.3 | 738 | 12/7/2023 |
8.0.2 | 634 | 12/6/2023 |
8.0.1 | 581 | 12/5/2023 |
8.0.0 | 480 | 12/5/2023 |
7.9.9 | 823 | 12/5/2023 |
7.9.8 | 712 | 12/5/2023 |
7.9.7 | 690 | 12/4/2023 |
7.9.6 | 542 | 12/4/2023 |
7.9.5 | 615 | 12/1/2023 |
7.9.4 | 884 | 11/24/2023 |
7.9.3 | 580 | 11/24/2023 |
7.9.2 | 752 | 11/23/2023 |
7.9.1 | 758 | 11/17/2023 |
7.9.0 | 581 | 11/17/2023 |
7.8.9 | 581 | 11/17/2023 |
7.8.8 | 637 | 11/16/2023 |
7.8.7 | 492 | 11/16/2023 |
7.8.6 | 627 | 11/16/2023 |
7.8.5 | 577 | 11/16/2023 |
7.8.4 | 546 | 11/15/2023 |
7.8.3 | 491 | 11/14/2023 |
7.8.2 | 588 | 11/10/2023 |
7.8.1 | 692 | 11/10/2023 |
7.8.0 | 652 | 11/10/2023 |
7.7.9 | 567 | 11/9/2023 |
7.7.8 | 507 | 11/9/2023 |
7.7.7 | 607 | 11/8/2023 |
7.7.6 | 557 | 11/8/2023 |
7.7.5 | 639 | 11/7/2023 |
7.7.4 | 618 | 11/7/2023 |
7.7.3 | 510 | 11/7/2023 |
7.7.2 | 554 | 11/7/2023 |
7.7.1 | 596 | 11/7/2023 |
7.7.0 | 709 | 11/3/2023 |
7.6.9 | 657 | 11/3/2023 |
7.6.8 | 712 | 11/3/2023 |
7.6.7 | 591 | 11/3/2023 |
7.6.6 | 685 | 11/2/2023 |
7.6.5 | 745 | 10/31/2023 |
7.6.4 | 613 | 10/31/2023 |
7.6.3 | 594 | 10/30/2023 |
7.6.2 | 718 | 10/27/2023 |
7.6.1 | 644 | 10/27/2023 |
7.6.0 | 656 | 10/27/2023 |
7.5.9 | 809 | 10/27/2023 |
7.5.8 | 675 | 10/27/2023 |
7.5.7 | 658 | 10/26/2023 |
7.5.6 | 701 | 10/26/2023 |
7.5.5 | 700 | 10/26/2023 |
7.5.4 | 510 | 10/26/2023 |
7.5.3 | 719 | 10/25/2023 |
7.5.2 | 641 | 10/25/2023 |
7.5.1 | 757 | 10/25/2023 |
7.5.0 | 763 | 10/24/2023 |
7.4.9 | 663 | 10/24/2023 |
7.4.8 | 759 | 10/24/2023 |
7.4.7 | 682 | 10/23/2023 |
7.4.6 | 762 | 10/20/2023 |
7.4.5 | 758 | 10/20/2023 |
7.4.4 | 602 | 10/18/2023 |
7.4.3 | 935 | 10/9/2023 |
7.4.2 | 541 | 10/8/2023 |
7.4.1 | 812 | 10/7/2023 |
7.4.0 | 739 | 9/15/2023 |
7.3.9 | 641 | 9/15/2023 |
7.3.8 | 662 | 9/14/2023 |
7.3.7 | 593 | 9/14/2023 |
7.3.6 | 710 | 9/14/2023 |
7.3.5 | 821 | 9/13/2023 |
7.3.4 | 697 | 9/13/2023 |
7.3.3 | 664 | 9/13/2023 |
7.3.2 | 566 | 9/12/2023 |
7.3.1 | 732 | 9/12/2023 |
7.3.0 | 782 | 9/12/2023 |
7.2.9 | 798 | 9/7/2023 |
7.2.8 | 728 | 9/7/2023 |
7.2.7 | 589 | 9/6/2023 |
7.2.6 | 724 | 9/6/2023 |
7.2.5 | 795 | 9/6/2023 |
7.2.4 | 742 | 8/31/2023 |
7.2.3 | 767 | 8/31/2023 |
7.2.2 | 647 | 8/30/2023 |
7.2.1 | 724 | 8/30/2023 |
7.2.0 | 775 | 8/30/2023 |
7.1.9 | 776 | 8/29/2023 |
7.1.8 | 708 | 8/29/2023 |
7.1.7 | 670 | 8/29/2023 |
7.1.6 | 656 | 8/29/2023 |
7.1.5 | 893 | 8/28/2023 |
7.1.4 | 804 | 8/28/2023 |
7.1.3 | 664 | 8/28/2023 |
7.1.2 | 784 | 8/25/2023 |
7.1.1 | 797 | 8/25/2023 |
7.1.0 | 694 | 8/25/2023 |
7.0.9 | 722 | 8/25/2023 |
7.0.8 | 539 | 8/24/2023 |
7.0.7 | 657 | 8/24/2023 |
7.0.6 | 757 | 8/24/2023 |
7.0.5 | 807 | 8/24/2023 |
7.0.4 | 687 | 8/23/2023 |
6.9.18 | 917 | 8/22/2023 |
6.9.17 | 811 | 8/22/2023 |
6.9.16 | 739 | 8/22/2023 |
6.9.15 | 778 | 8/22/2023 |
6.9.14 | 834 | 8/22/2023 |
6.9.13 | 744 | 8/22/2023 |
6.9.12 | 737 | 8/20/2023 |
6.9.11 | 749 | 8/19/2023 |
6.9.10 | 635 | 8/19/2023 |
6.9.9 | 858 | 8/19/2023 |