XUCore.Template.Mediator
8.0.1
dotnet new install XUCore.Template.Mediator::8.0.1
XUCore.Template.Mediator
XUCore.Template.Mediator
基于 Mediator 的快速开发项目模板,生成 WebApi 项目
使用模板
本地安装模板:可详情见 install-template.bat
文件内
本地安装模板步骤:
如果已经装过旧版,可以先执行下面命令进行卸载:
dotnet new -u xmediator
然后安装指定版本:
dotnet new --install XUCore.Template.Mediator::{version}
创建项目
切换到指定创建的目录。
假设我们需要在 E:\demo
创建,
那么先切换到该目录
cd E:\demo
然后执行下面命令创建项目
dotnet new xmediator -n MyTest -o .
这里的 xmediator
是使用模板短名称。
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 |
---|---|---|
8.0.1 | 2,767 | 12/5/2023 |
8.0.0 | 204 | 12/5/2023 |
7.9.9 | 231 | 12/5/2023 |
7.9.8 | 169 | 12/5/2023 |
7.9.7 | 225 | 12/4/2023 |
7.9.6 | 240 | 12/4/2023 |
7.9.5 | 269 | 12/1/2023 |
7.9.4 | 329 | 11/24/2023 |
7.9.3 | 227 | 11/24/2023 |
7.9.2 | 167 | 11/23/2023 |
7.9.1 | 306 | 11/17/2023 |
7.9.0 | 211 | 11/17/2023 |
7.8.9 | 171 | 11/17/2023 |
7.8.8 | 195 | 11/16/2023 |
7.8.7 | 202 | 11/16/2023 |
7.8.6 | 175 | 11/16/2023 |
7.8.5 | 191 | 11/16/2023 |
7.8.4 | 204 | 11/15/2023 |
7.8.3 | 234 | 11/14/2023 |
7.8.2 | 249 | 11/10/2023 |
7.8.1 | 210 | 11/10/2023 |
7.8.0 | 146 | 11/10/2023 |
7.7.9 | 215 | 11/9/2023 |
7.7.8 | 196 | 11/9/2023 |
7.7.7 | 162 | 11/8/2023 |
7.7.6 | 180 | 11/8/2023 |
7.7.5 | 206 | 11/7/2023 |
7.7.4 | 190 | 11/7/2023 |
7.7.3 | 170 | 11/7/2023 |
7.7.2 | 210 | 11/7/2023 |
7.7.1 | 128 | 11/7/2023 |
7.7.0 | 363 | 11/3/2023 |
7.6.9 | 282 | 11/3/2023 |
7.6.8 | 244 | 11/3/2023 |
7.6.7 | 246 | 11/3/2023 |
7.6.6 | 295 | 11/2/2023 |
7.6.5 | 300 | 10/31/2023 |
7.6.4 | 266 | 10/31/2023 |
7.6.3 | 322 | 10/30/2023 |
7.6.2 | 375 | 10/27/2023 |
7.6.1 | 303 | 10/27/2023 |
7.6.0 | 285 | 10/27/2023 |
7.5.9 | 320 | 10/27/2023 |
7.5.8 | 325 | 10/27/2023 |
7.5.7 | 310 | 10/26/2023 |
7.5.6 | 308 | 10/26/2023 |
7.5.5 | 315 | 10/26/2023 |
7.5.4 | 342 | 10/26/2023 |
7.5.3 | 368 | 10/25/2023 |
7.5.2 | 333 | 10/25/2023 |
7.5.1 | 306 | 10/25/2023 |
7.5.0 | 289 | 10/24/2023 |
7.4.9 | 315 | 10/24/2023 |
7.4.8 | 286 | 10/24/2023 |
7.4.7 | 320 | 10/23/2023 |
7.4.6 | 433 | 10/20/2023 |
7.4.5 | 295 | 10/20/2023 |
7.4.4 | 379 | 10/18/2023 |
7.4.3 | 531 | 10/9/2023 |
7.4.2 | 249 | 10/8/2023 |
7.4.1 | 300 | 10/7/2023 |
7.4.0 | 320 | 9/15/2023 |
7.3.9 | 285 | 9/15/2023 |
7.3.8 | 254 | 9/14/2023 |
7.3.7 | 289 | 9/14/2023 |
7.3.6 | 314 | 9/14/2023 |
7.3.5 | 348 | 9/13/2023 |
7.3.4 | 311 | 9/13/2023 |
7.3.3 | 287 | 9/13/2023 |
7.3.2 | 288 | 9/12/2023 |
7.3.1 | 345 | 9/12/2023 |
7.3.0 | 306 | 9/12/2023 |
7.2.9 | 330 | 9/7/2023 |
7.2.8 | 349 | 9/7/2023 |
7.2.7 | 340 | 9/6/2023 |
7.2.6 | 374 | 9/6/2023 |
7.2.5 | 324 | 9/6/2023 |
7.2.4 | 314 | 8/31/2023 |
7.2.3 | 342 | 8/31/2023 |
7.2.2 | 312 | 8/30/2023 |
7.2.1 | 361 | 8/30/2023 |
7.2.0 | 299 | 8/30/2023 |
7.1.9 | 266 | 8/29/2023 |
7.1.8 | 280 | 8/29/2023 |
7.1.7 | 266 | 8/29/2023 |
7.1.6 | 319 | 8/29/2023 |
7.1.5 | 308 | 8/28/2023 |
7.1.4 | 341 | 8/28/2023 |
7.1.3 | 370 | 8/28/2023 |
7.1.2 | 270 | 8/25/2023 |
7.1.1 | 310 | 8/25/2023 |
7.1.0 | 289 | 8/25/2023 |
7.0.9 | 335 | 8/25/2023 |
7.0.8 | 267 | 8/24/2023 |
7.0.7 | 324 | 8/24/2023 |
7.0.6 | 304 | 8/24/2023 |
7.0.5 | 339 | 8/24/2023 |
7.0.4 | 326 | 8/23/2023 |
7.0.3 | 245 | 8/23/2023 |
7.0.2 | 275 | 8/23/2023 |
7.0.1 | 287 | 8/23/2023 |
7.0.0 | 258 | 8/22/2023 |
6.9.18 | 348 | 8/22/2023 |
6.9.17 | 296 | 8/22/2023 |
6.9.16 | 358 | 8/22/2023 |
6.9.15 | 352 | 8/22/2023 |
6.9.14 | 282 | 8/22/2023 |
6.9.13 | 306 | 8/22/2023 |
6.9.12 | 338 | 8/20/2023 |
6.9.11 | 267 | 8/19/2023 |
6.9.10 | 360 | 8/19/2023 |
6.9.9 | 332 | 8/19/2023 |