add
This commit is contained in:
V-LiuShuang
+85
-85
@@ -5,89 +5,7 @@ description: 在mis-paw模块编写代码必备技能。
|
||||
|
||||
# Intro
|
||||
|
||||
请结合[目录结构](#目录结构)与[核心技术栈](#核心技术栈)，并严格遵守[代码编写规范](#代码编写规范)修改、编写代码。
|
||||
|
||||
## FAQ
|
||||
|
||||
### 怎么确认用哪个profile？
|
||||
|
||||
没有指定默认使用dev。
|
||||
|
||||
### 怎么读profile的配置？
|
||||
|
||||
从[项目根目录](#项目根目录)的`pom.xml`文件中获取不同`profiles.active`的配置，示例：
|
||||
|
||||
```xml
|
||||
<!-- 环境标识，可用的数值有：dev、qas -->
|
||||
<profiles.active>dev</profiles.active>
|
||||
<!-- 当前环境的Nacos服务地址 -->
|
||||
<nacos.server>127.0.0.1:8868</nacos.server>
|
||||
<!-- 当前环境的Nacos注册中心分组名称 -->
|
||||
<nacos.discovery.group>DEFAULT_GROUP</nacos.discovery.group>
|
||||
<!-- 当前环境的Nacos配置中心分组名称 -->
|
||||
<nacos.config.group>DEFAULT_GROUP</nacos.config.group>
|
||||
<!-- 当前环境的Nacos登录账号 -->
|
||||
<nacos.username>nacos</nacos.username>
|
||||
<!-- 当前环境的Nacos登录密码 -->
|
||||
<nacos.password>1234567890</nacos.password>
|
||||
<!-- 当前环境的NewAPI服务地址 -->
|
||||
<newAPI.url>http://127.0.0.1:3000</newAPI.url>
|
||||
<!-- 当前环境的NewAPI模型ApiKey -->
|
||||
<newAPI.key>sk-xxx</newAPI.key>
|
||||
```
|
||||
|
||||
### 怎么打包？
|
||||
|
||||
系统已安装`mvnd`用来替换`mvn`命令，先确认该用哪个profile，获取`profiles.active`后在[项目根目录](#项目根目录)执行如下命令即可，**耗时约80秒**，示例：`mvnd clean package -DskipTests -Pdev`。
|
||||
|
||||
### 怎么读取nacos配置文件？
|
||||
|
||||
按步骤一步步执行：
|
||||
|
||||
1. 根据当前Git分支确认使用哪个profile，从**项目根目录**的`pom.xml`获取以下几个属性：
|
||||
|
||||
- `profiles.active`
|
||||
- `nacos.server`
|
||||
- `nacos.config.group`
|
||||
- `nacos.username`
|
||||
- `nacos.password`
|
||||
|
||||
2. 获取accessToken。
|
||||
|
||||
请求示例：
|
||||
```bash
|
||||
curl -X POST 'http://{nacos.server}/nacos/v1/auth/login' -d 'username={nacos.username}&password={nacos.password}'
|
||||
```
|
||||
|
||||
输出示例：
|
||||
```json
|
||||
{"accessToken":"xxx"}
|
||||
```
|
||||
|
||||
如果输出不包含accessToken字段视为失败，**最多重试2次，仍然失败则直接中断整个流程。**
|
||||
|
||||
3. 获取配置文件信息。
|
||||
|
||||
- `dataId`：如果要请求MySQL执行SQL使用`datasource.yml`，否则使用`mis-agent.yml`。
|
||||
- `accessToken`：上一步得到的`accessToken`。
|
||||
|
||||
请求示例：
|
||||
|
||||
```bash
|
||||
curl -X GET "http://{nacos.server}/nacos/v3/console/cs/config?dataId={dataId}&groupName={groupName}&namespaceId={profiles.active}" -H "Authorization: Bearer {accessToken}"
|
||||
```
|
||||
|
||||
输出示例：
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 0,
|
||||
"message": "success",
|
||||
"data": {"content": "..."}
|
||||
}
|
||||
```
|
||||
|
||||
`data.content`就是配置内容，通常是yaml格式。
|
||||
请结合[目录结构](#目录结构)与[核心技术栈](#核心技术栈)，并严格遵守[代码编写规范](#代码编写规范)生成代码，被要求编写HTTP接口文档时，请参考[HTTP接口文档示例](./examples/api-doc.md)。
|
||||
|
||||
## 核心技术栈
|
||||
|
||||
@@ -372,7 +290,7 @@ public enum StateEnum {
|
||||
}
|
||||
```
|
||||
|
||||
## DTO实例
|
||||
## DTO示例
|
||||
|
||||
```java
|
||||
import com.fasterxml.jackson.annotation.JsonFormat;
|
||||
@@ -426,4 +344,86 @@ public class ExampleDTO implements Serializable {
|
||||
private StateEnum state;
|
||||
|
||||
}
|
||||
```
|
||||
```
|
||||
|
||||
## FAQ
|
||||
|
||||
### 怎么确认用哪个profile？
|
||||
|
||||
没有指定默认使用dev。
|
||||
|
||||
### 怎么读profile的配置？
|
||||
|
||||
从[项目根目录](#项目根目录)的`pom.xml`文件中获取不同`profiles.active`的配置，示例：
|
||||
|
||||
```xml
|
||||
<!-- 环境标识，可用的数值有：dev、qas -->
|
||||
<profiles.active>dev</profiles.active>
|
||||
<!-- 当前环境的Nacos服务地址 -->
|
||||
<nacos.server>127.0.0.1:8868</nacos.server>
|
||||
<!-- 当前环境的Nacos注册中心分组名称 -->
|
||||
<nacos.discovery.group>DEFAULT_GROUP</nacos.discovery.group>
|
||||
<!-- 当前环境的Nacos配置中心分组名称 -->
|
||||
<nacos.config.group>DEFAULT_GROUP</nacos.config.group>
|
||||
<!-- 当前环境的Nacos登录账号 -->
|
||||
<nacos.username>nacos</nacos.username>
|
||||
<!-- 当前环境的Nacos登录密码 -->
|
||||
<nacos.password>1234567890</nacos.password>
|
||||
<!-- 当前环境的NewAPI服务地址 -->
|
||||
<newAPI.url>http://127.0.0.1:3000</newAPI.url>
|
||||
<!-- 当前环境的NewAPI模型ApiKey -->
|
||||
<newAPI.key>sk-xxx</newAPI.key>
|
||||
```
|
||||
|
||||
### 怎么打包？
|
||||
|
||||
系统已安装`mvnd`用来替换`mvn`命令，先确认该用哪个profile，获取`profiles.active`后在[项目根目录](#项目根目录)执行如下命令即可，**耗时约80秒**，示例：`mvnd clean package -DskipTests -Pdev`。
|
||||
|
||||
### 怎么读取nacos配置文件？
|
||||
|
||||
按步骤一步步执行：
|
||||
|
||||
1. 根据当前Git分支确认使用哪个profile，从**项目根目录**的`pom.xml`获取以下几个属性：
|
||||
|
||||
- `profiles.active`
|
||||
- `nacos.server`
|
||||
- `nacos.config.group`
|
||||
- `nacos.username`
|
||||
- `nacos.password`
|
||||
|
||||
2. 获取accessToken。
|
||||
|
||||
请求示例：
|
||||
```bash
|
||||
curl -X POST 'http://{nacos.server}/nacos/v1/auth/login' -d 'username={nacos.username}&password={nacos.password}'
|
||||
```
|
||||
|
||||
输出示例：
|
||||
```json
|
||||
{"accessToken":"xxx"}
|
||||
```
|
||||
|
||||
如果输出不包含accessToken字段视为失败，**最多重试2次，仍然失败则直接中断整个流程。**
|
||||
|
||||
3. 获取配置文件信息。
|
||||
|
||||
- `dataId`：如果要请求MySQL执行SQL使用`datasource.yml`，否则使用`mis-agent.yml`。
|
||||
- `accessToken`：上一步得到的`accessToken`。
|
||||
|
||||
请求示例：
|
||||
|
||||
```bash
|
||||
curl -X GET "http://{nacos.server}/nacos/v3/console/cs/config?dataId={dataId}&groupName={groupName}&namespaceId={profiles.active}" -H "Authorization: Bearer {accessToken}"
|
||||
```
|
||||
|
||||
输出示例：
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 0,
|
||||
"message": "success",
|
||||
"data": {"content": "..."}
|
||||
}
|
||||
```
|
||||
|
||||
`data.content`就是配置内容，通常是yaml格式。
|
||||
Reference in New Issue
Block a user