XUCore.Template.WeChatClub 9.3.5

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

XUCore.Template.WeChatClub

XUCore.Template.WeChatClub

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

使用模板

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

本地安装模板步骤

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


dotnet new -u xclub

然后安装指定版本:


dotnet new --install XUCore.Template.WeChatClub::6.5.2

创建项目

切换到指定创建的目录。

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

那么先切换到该目录


cd E:\demo

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


dotnet new xclub -n MyTest -o .

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

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 37 6/14/2024
9.4.1 38 6/14/2024
9.3.11 94 6/4/2024
9.3.10 120 6/4/2024
9.3.9 108 5/31/2024
9.3.8 144 5/28/2024
9.3.7 226 5/24/2024
9.3.6 120 5/23/2024
9.3.5 138 5/23/2024
9.3.4 131 5/22/2024
9.3.3 251 5/15/2024
9.3.2 127 5/15/2024
9.3.1 106 5/15/2024
9.2.19 117 5/14/2024
9.2.18 87 5/14/2024
9.2.17 82 5/14/2024
9.2.16 134 5/14/2024
9.2.15 117 5/13/2024
9.2.14 95 5/13/2024
9.2.13 87 5/13/2024
9.2.12 85 5/12/2024
9.2.11 149 5/11/2024
9.2.10 122 5/10/2024
9.2.9 127 5/9/2024
9.2.8 161 5/7/2024
9.2.7 169 5/7/2024
9.2.6 111 4/29/2024
9.2.5 134 4/25/2024
9.2.4 123 4/22/2024
9.2.3 108 4/19/2024
9.2.2 121 4/19/2024
9.2.1 130 4/17/2024
9.1.13 150 4/16/2024
9.1.12 136 4/16/2024
9.1.11 166 4/16/2024
9.1.10 171 4/14/2024
9.1.9 120 4/14/2024
9.1.8 132 4/12/2024
9.1.7 112 4/12/2024
9.1.6 124 4/12/2024
9.1.5 136 4/11/2024
9.1.4 139 4/11/2024
9.1.3 157 4/11/2024
9.1.2 109 4/10/2024
9.1.1 149 4/9/2024
8.11.12 128 4/9/2024
8.11.11 125 4/3/2024
8.11.10 155 3/29/2024
8.11.9 175 3/28/2024
8.11.8 183 3/26/2024
8.11.7 180 3/25/2024
8.11.6 276 3/21/2024
8.11.5 429 3/13/2024
8.11.4 270 3/10/2024
8.11.3 289 3/4/2024
8.11.2 182 3/4/2024
8.11.1 287 3/1/2024
8.10.14 366 2/21/2024
8.10.13 147 2/20/2024
8.10.12 112 2/20/2024
8.10.11 139 2/20/2024
8.10.10 126 2/20/2024
8.10.9 125 2/20/2024
8.10.8 126 2/20/2024
8.10.7 189 2/18/2024
8.10.6 163 2/18/2024
8.10.5 427 2/6/2024
8.10.4 122 2/6/2024
8.10.3 152 2/4/2024
8.10.2 101 2/4/2024
8.10.1 88 2/4/2024
8.9.9 156 2/3/2024
8.9.8 150 2/3/2024
8.9.7 355 1/26/2024
8.9.6 157 1/26/2024
8.9.5 152 1/25/2024
8.9.4 132 1/25/2024
8.9.3 143 1/24/2024
8.9.2 115 1/23/2024
8.9.1 129 1/23/2024
8.9.0 138 1/23/2024
8.8.9 131 1/23/2024
8.8.8 136 1/22/2024
8.8.7 97 1/22/2024
8.8.6 83 1/22/2024
8.8.5 130 1/22/2024
8.8.4 114 1/22/2024
8.8.3 122 1/22/2024
8.8.2 165 1/20/2024
8.8.1 120 1/20/2024
8.8.0 132 1/20/2024
8.7.9 157 1/20/2024
8.7.8 147 1/20/2024
8.7.7 141 1/19/2024
8.7.6 131 1/19/2024
8.7.5 126 1/19/2024
8.7.4 100 1/19/2024
8.7.3 145 1/19/2024
8.7.2 87 1/19/2024
8.7.1 106 1/19/2024
8.7.0 128 1/18/2024
8.6.9 134 1/18/2024
8.6.8 130 1/18/2024
8.6.7 106 1/18/2024
8.6.6 149 1/18/2024
8.6.5 152 1/18/2024
8.6.4 162 1/17/2024
8.6.3 147 1/17/2024
8.6.2 124 1/17/2024
8.6.1 127 1/16/2024
8.6.0 138 1/16/2024
8.5.9 154 1/16/2024
8.5.8 174 1/15/2024
8.5.7 117 1/15/2024
8.5.6 86 1/15/2024
8.5.5 142 1/14/2024
8.5.4 133 1/14/2024
8.5.3 161 1/13/2024
8.5.2 152 1/13/2024
8.5.1 105 1/13/2024
8.5.0 147 1/12/2024
8.4.9 222 1/11/2024
8.4.8 191 1/11/2024
8.4.7 183 1/10/2024
8.4.6 199 1/10/2024
8.4.5 155 1/10/2024
8.4.4 162 1/9/2024
8.4.3 221 1/8/2024
8.4.2 188 1/8/2024
8.4.1 189 1/8/2024
8.4.0 200 1/8/2024
8.3.9 197 1/8/2024
8.3.8 177 1/8/2024
8.3.7 203 1/8/2024
8.3.6 198 1/6/2024
8.3.5 184 1/5/2024
8.3.4 180 1/5/2024
8.3.3 207 1/5/2024
8.3.2 135 1/5/2024
8.3.1 166 1/5/2024
8.3.0 121 1/5/2024
8.2.9 186 1/5/2024
8.2.8 207 1/4/2024
8.2.7 171 1/4/2024
8.2.6 176 1/4/2024
8.2.5 163 1/4/2024
8.2.4 185 1/3/2024
8.2.3 216 1/3/2024
8.2.2 219 1/3/2024
8.2.1 175 1/3/2024
8.2.0 223 1/2/2024
8.1.9 202 1/2/2024
8.1.8 354 12/25/2023
8.1.7 325 12/18/2023
8.1.6 212 12/15/2023
8.1.5 169 12/14/2023
8.1.4 143 12/14/2023
8.1.3 189 12/14/2023
8.1.2 115 12/14/2023
8.1.1 154 12/14/2023
8.1.0 177 12/13/2023
8.0.9 175 12/13/2023
8.0.8 172 12/13/2023
8.0.7 109 12/13/2023
8.0.6 183 12/12/2023
8.0.5 191 12/12/2023
8.0.4 208 12/11/2023
8.0.3 245 12/7/2023
8.0.2 200 12/6/2023
8.0.1 199 12/5/2023
8.0.0 154 12/5/2023
7.9.9 167 12/5/2023
7.9.8 146 12/5/2023
7.9.7 149 12/4/2023
7.9.6 134 12/4/2023
7.9.5 274 12/1/2023
7.9.4 371 11/24/2023
7.9.3 195 11/24/2023
7.9.2 172 11/23/2023
7.9.1 346 11/17/2023
7.9.0 156 11/17/2023
7.8.9 99 11/17/2023
7.8.8 128 11/16/2023
7.8.7 138 11/16/2023
7.8.6 151 11/16/2023
7.8.5 148 11/16/2023
7.8.4 141 11/15/2023
7.8.3 180 11/14/2023
7.8.2 211 11/10/2023
7.8.1 152 11/10/2023
7.8.0 126 11/10/2023
7.7.9 139 11/9/2023
7.7.8 155 11/9/2023
7.7.7 166 11/8/2023
7.7.6 155 11/8/2023
7.7.5 165 11/7/2023
7.7.4 177 11/7/2023
7.7.3 125 11/7/2023
7.7.2 158 11/7/2023
7.7.1 154 11/7/2023
7.7.0 294 11/3/2023
7.6.9 204 11/3/2023
7.6.8 185 11/3/2023
7.6.7 192 11/3/2023
7.6.6 222 11/2/2023
7.6.5 276 10/31/2023
7.6.4 204 10/31/2023
7.6.3 232 10/30/2023
7.6.2 320 10/27/2023
7.6.1 256 10/27/2023
7.6.0 206 10/27/2023
7.5.9 210 10/27/2023
7.5.8 306 10/27/2023
7.5.7 262 10/26/2023
7.5.6 257 10/26/2023
7.5.5 271 10/26/2023
7.5.4 258 10/26/2023
7.5.3 279 10/25/2023
7.5.2 279 10/25/2023
7.5.1 296 10/25/2023
7.5.0 259 10/24/2023
7.4.9 273 10/24/2023
7.4.8 306 10/24/2023
7.4.7 193 10/23/2023
7.4.6 348 10/20/2023
7.4.5 251 10/20/2023
7.4.4 296 10/18/2023
7.4.3 485 10/9/2023
7.4.2 270 10/8/2023
7.4.1 231 10/7/2023
7.4.0 203 9/15/2023
7.3.9 174 9/15/2023
7.3.8 225 9/14/2023
7.3.7 150 9/14/2023
7.3.6 160 9/14/2023
7.3.5 241 9/13/2023
7.3.4 188 9/13/2023
7.3.3 230 9/13/2023
7.3.2 231 9/12/2023
7.3.1 248 9/12/2023
7.3.0 203 9/12/2023
7.2.9 237 9/7/2023
7.2.8 224 9/7/2023
7.2.7 233 9/6/2023
7.2.6 192 9/6/2023
7.2.5 226 9/6/2023
7.2.4 226 8/31/2023
7.2.3 221 8/31/2023
7.2.2 207 8/30/2023
7.2.1 253 8/30/2023
7.2.0 243 8/30/2023
7.1.9 256 8/29/2023
7.1.8 187 8/29/2023
7.1.7 241 8/29/2023
7.1.6 305 8/29/2023
7.1.5 236 8/28/2023
7.1.4 262 8/28/2023
7.1.3 252 8/28/2023
7.1.2 245 8/25/2023
7.1.1 272 8/25/2023
7.1.0 252 8/25/2023
7.0.9 235 8/25/2023
7.0.8 179 8/24/2023
7.0.7 233 8/24/2023
7.0.6 288 8/24/2023
7.0.5 282 8/24/2023
7.0.4 265 8/23/2023
7.0.3 253 8/23/2023
7.0.2 248 8/23/2023
7.0.1 269 8/23/2023
7.0.0 279 8/22/2023
6.9.18 366 8/22/2023
6.9.17 217 8/22/2023
6.9.16 176 8/22/2023
6.9.15 254 8/22/2023
6.9.14 249 8/22/2023
6.9.13 239 8/22/2023
6.9.12 293 8/20/2023
6.9.11 268 8/19/2023
6.9.10 276 8/19/2023
6.9.9 293 8/19/2023