add
This commit is contained in:
V-LiuShuang committed
1 parent
2b95999e87
commit
60495cec83
12 files changed
-561
No files matched your search
@@ -1,26 +0,0 @@
|
|||||||
---
|
|
||||||
name: mis-spec
|
|
||||||
description: 在mis编写代码的必备技能。
|
|
||||||
---
|
|
||||||
|
|
||||||
# mis-spec
|
|
||||||
|
|
||||||
请结合[核心技术栈](./references/core_arch.md)、[MVC通用目录结构](./references/mvc_dir.md)，并严格遵守[代码编写规范](./references/coding_rules.md)生成代码，被要求编写HTTP接口文档时，请参考[api-doc.md](./examples//api-doc.md)文档生成。
|
|
||||||
|
|
||||||
## 示例代码
|
|
||||||
|
|
||||||
- [MySQL建表语句示例](./examples/example_table.sql)
|
|
||||||
- [Java实体类示例](./examples/ExampleEntity.java)
|
|
||||||
- [Java枚举类示例](./examples/StateEnum.java)
|
|
||||||
- [DTO或者VO示例](./examples/ExampleDTO.java)
|
|
||||||
|
|
||||||
## FAQ
|
|
||||||
|
|
||||||
| 问题 | 答案 |
|
|
||||||
|:---|:---|
|
|
||||||
|项目根目录在哪？|一般就位于当前工作目录！|
|
|
||||||
|该用哪个profile执行编译？|向用户询问，可用的数值有：dev、local、qas、prd。|
|
|
||||||
|怎么读profile的配置？| 阅读文档[read_profile.md](./references/read_profile.md)|
|
|
||||||
|怎么编译或打包？|系统已安装`mvnd`用来替换`mvn`命令，在**项目根目录**执行命令：`mvnd clean package -DskipTests -Plocal`，**耗时约200秒**。|
|
|
||||||
|怎么读取nacos配置文件？|阅读文档[read_nacos_config.md](./references/read_nacos_config.md)|
|
|
||||||
|如何发起重试？比如提高异步任务可靠性！|阅读文档[worksheet.md](./references/worksheet.md)|
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
import com.fasterxml.jackson.annotation.JsonFormat;
|
|
||||||
import io.swagger.v3.oas.annotations.media.Schema;
|
|
||||||
import jakarta.validation.constraints.NotBlank;
|
|
||||||
import jakarta.validation.constraints.NotNull;
|
|
||||||
import lombok.Data;
|
|
||||||
import lombok.Getter;
|
|
||||||
import org.springframework.format.annotation.DateTimeFormat;
|
|
||||||
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
|
|
||||||
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
|
|
||||||
import java.io.Serial;
|
|
||||||
import java.io.Serializable;
|
|
||||||
import java.time.LocalDate;
|
|
||||||
import java.time.LocalDateTime;
|
|
||||||
import java.math.BigDecimal;
|
|
||||||
|
|
||||||
@Data
|
|
||||||
@Schema(title = "DTO示例")
|
|
||||||
public class ExampleDTO implements Serializable {
|
|
||||||
|
|
||||||
@Serial
|
|
||||||
private static final long serialVersionUID = 1L;
|
|
||||||
|
|
||||||
@NotBlank
|
|
||||||
@Schema(description = "字符串")
|
|
||||||
private String strField;
|
|
||||||
|
|
||||||
@Schema(description = "长整数")
|
|
||||||
@JsonSerialize(using = ToStringSerializer.class)
|
|
||||||
private Long longField;
|
|
||||||
|
|
||||||
@NotNull
|
|
||||||
@Schema(description = "日期类型", pattern = "yyyy-MM-dd")
|
|
||||||
@DateTimeFormat(pattern = "yyyy-MM-dd")
|
|
||||||
@JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8")
|
|
||||||
private LocalDate dateField;
|
|
||||||
|
|
||||||
@NotNull
|
|
||||||
@Schema(description = "时间类型", pattern = "yyyy-MM-dd HH:mm:ss")
|
|
||||||
@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
|
|
||||||
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
|
|
||||||
private LocalDateTime timeField;
|
|
||||||
|
|
||||||
@NotNull
|
|
||||||
@Schema(
|
|
||||||
title = "状态",
|
|
||||||
description = "参考示例值",
|
|
||||||
example = StateEnum.DESC
|
|
||||||
)
|
|
||||||
private StateEnum state;
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,93 +0,0 @@
|
|||||||
import com.baomidou.mybatisplus.annotation.IdType;
|
|
||||||
import com.baomidou.mybatisplus.annotation.TableField;
|
|
||||||
import com.baomidou.mybatisplus.annotation.TableId;
|
|
||||||
import com.baomidou.mybatisplus.annotation.TableName;
|
|
||||||
import com.fasterxml.jackson.annotation.JsonFormat;
|
|
||||||
import io.swagger.v3.oas.annotations.media.Schema;
|
|
||||||
import jakarta.validation.constraints.NotBlank;
|
|
||||||
import jakarta.validation.constraints.NotNull;
|
|
||||||
import lombok.Data;
|
|
||||||
import lombok.Getter;
|
|
||||||
import org.springframework.format.annotation.DateTimeFormat;
|
|
||||||
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
|
|
||||||
import com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler;
|
|
||||||
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
|
|
||||||
import java.io.Serial;
|
|
||||||
import java.io.Serializable;
|
|
||||||
import java.time.LocalDate;
|
|
||||||
import java.time.LocalDateTime;
|
|
||||||
import java.math.BigDecimal;
|
|
||||||
|
|
||||||
@Data
|
|
||||||
@TableName(value = "example_table", autoResultMap = true)
|
|
||||||
@Schema(title = "示例表")
|
|
||||||
public class ExampleEntity implements Serializable {
|
|
||||||
|
|
||||||
@Serial
|
|
||||||
private static final long serialVersionUID = 1L;
|
|
||||||
|
|
||||||
@Schema(description = "ID")
|
|
||||||
@TableId(value = "id", type = IdType.ASSIGN_ID)
|
|
||||||
@TableField(value = "id")
|
|
||||||
@JsonSerialize(using = ToStringSerializer.class)
|
|
||||||
private Long id;
|
|
||||||
|
|
||||||
@NotBlank
|
|
||||||
@Schema(description = "字符串")
|
|
||||||
@TableField(value = "str_field")
|
|
||||||
private String strField;
|
|
||||||
|
|
||||||
@Schema(description = "整数", defaultValue = "0")
|
|
||||||
@TableField(value = "int_field")
|
|
||||||
private Integer intField;
|
|
||||||
|
|
||||||
@Schema(description = "长整数")
|
|
||||||
@TableField(value = "long_field")
|
|
||||||
@JsonSerialize(using = ToStringSerializer.class)
|
|
||||||
private Long longField;
|
|
||||||
|
|
||||||
@Schema(description = "高精度浮点数")
|
|
||||||
@TableField(value = "decimal_field")
|
|
||||||
private BigDecimal decimalField;
|
|
||||||
|
|
||||||
@NotNull
|
|
||||||
@Schema(description = "日期类型", pattern = "yyyy-MM-dd")
|
|
||||||
@TableField(value = "date_field")
|
|
||||||
@DateTimeFormat(pattern = "yyyy-MM-dd")
|
|
||||||
@JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8")
|
|
||||||
private LocalDate dateField;
|
|
||||||
|
|
||||||
@NotNull
|
|
||||||
@Schema(description = "时间类型", pattern = "yyyy-MM-dd HH:mm:ss")
|
|
||||||
@TableField(value = "time_field")
|
|
||||||
@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
|
|
||||||
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
|
|
||||||
private LocalDateTime timeField;
|
|
||||||
|
|
||||||
@NotNull
|
|
||||||
@Schema(
|
|
||||||
title = "状态",
|
|
||||||
description = "参考示例值",
|
|
||||||
example = StateEnum.DESC
|
|
||||||
)
|
|
||||||
@TableField(value = "state")
|
|
||||||
private StateEnum state;
|
|
||||||
|
|
||||||
@Schema(description = "JSON类型")
|
|
||||||
@TableField(value = "json_field", typeHandler = JacksonTypeHandler.class)
|
|
||||||
private JsonField jsonField;
|
|
||||||
|
|
||||||
@Data
|
|
||||||
public static class JsonField implements Serializable {
|
|
||||||
|
|
||||||
@Serial
|
|
||||||
private static final long serialVersionUID = 1L;
|
|
||||||
|
|
||||||
@Schema(description = "示例字段1")
|
|
||||||
private String field1;
|
|
||||||
|
|
||||||
@Schema(description = "示例字段2")
|
|
||||||
private Integer field2;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
import com.baomidou.mybatisplus.annotation.EnumValue;
|
|
||||||
import com.fasterxml.jackson.annotation.JsonCreator;
|
|
||||||
import com.fasterxml.jackson.annotation.JsonValue;
|
|
||||||
import io.swagger.v3.oas.annotations.media.Schema;
|
|
||||||
import lombok.Getter;
|
|
||||||
import lombok.RequiredArgsConstructor;
|
|
||||||
|
|
||||||
@Getter
|
|
||||||
@RequiredArgsConstructor
|
|
||||||
@Schema(description = "某某状态")
|
|
||||||
public enum StateEnum {
|
|
||||||
|
|
||||||
ONLY_READ("only_read"),
|
|
||||||
|
|
||||||
READ_WRITE("read_write");
|
|
||||||
|
|
||||||
public static final String DESC = "only_read=只读、read_write=读写";
|
|
||||||
|
|
||||||
@JsonValue
|
|
||||||
@EnumValue
|
|
||||||
private final String value;
|
|
||||||
|
|
||||||
@JsonCreator
|
|
||||||
public static StateEnum deserialize(String input) {
|
|
||||||
return Arrays.stream(values()).filter(e -> e.getValue().equals(input)).findFirst().orElse(null);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,60 +0,0 @@
|
|||||||
# 智能体使用数据
|
|
||||||
|
|
||||||
以下是关于智能体使用数据的API文档。
|
|
||||||
|
|
||||||
## 累计使用数据卡片
|
|
||||||
|
|
||||||
- 请求地址：/agent/metrics/total
|
|
||||||
- 请求方式：GET
|
|
||||||
|
|
||||||
### 请求参数
|
|
||||||
|
|
||||||
| 参数名称 | 是否必传 | 类型 | 描述 |
|
|
||||||
|:-----|:-----|:-----|:-----|
|
|
||||||
| agentId | 是 | String | 智能体ID |
|
|
||||||
|
|
||||||
### 请求示例
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -X GET {gateway}/agent/metrics/total?agentId={agentId}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 响应参数
|
|
||||||
|
|
||||||
| 参数名称 | 类型 | 描述 |
|
|
||||||
|:-----|:-----|:-----|
|
|
||||||
| code | Number | 返回码（200=成功） |
|
|
||||||
| msg | String | 提示信息 |
|
|
||||||
| data | Object | 返回数据 |
|
|
||||||
| data.agentId | String | 智能体 ID |
|
|
||||||
| data.agentName | String | 智能体名称 |
|
|
||||||
| data.inputToken | Number | 累计输入Token |
|
|
||||||
| data.outputToken | Number | 累计输出Token |
|
|
||||||
| data.userNum | Number | 累计用户数 |
|
|
||||||
| data.chatNum | Number | 累计对话数 |
|
|
||||||
|
|
||||||
### 成功示例
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"code": 200,
|
|
||||||
"msg": "操作成功",
|
|
||||||
"data": {
|
|
||||||
"agentId": "123456",
|
|
||||||
"agentName": "智能体名称",
|
|
||||||
"inputToken": "123243654645",
|
|
||||||
"outputToken": "345645765765",
|
|
||||||
"userNum": 5678,
|
|
||||||
"chatNum": 45678999
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 失败示例
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"code": 500,
|
|
||||||
"msg": "错误信息"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
CREATE TABLE `example_table` (
|
|
||||||
`id` BIGINT NOT NULL COMMENT 'ID',
|
|
||||||
`str_field` VARCHAR(32) NOT NULL COMMENT '字符串`,
|
|
||||||
`int_field` INT DEFAULT NULL COMMENT '整数`,
|
|
||||||
`long_field` BIGINT DEFAULT NULL COMMENT '长整数`,
|
|
||||||
`decimal_field` DECIMAL(14, 2) DEFAULT NULL COMMENT '高精度浮点数`,
|
|
||||||
`date_field` DATE NOT NULL COMMENT '日期类型`,
|
|
||||||
`time_field` DATETIME NOT NULL COMMENT '日期类型`,
|
|
||||||
`state` VARCHAR(32) NOT NULL COMMENT '状态：only_read、read_write',
|
|
||||||
`json_field` JSON DATETIME NULL COMMENT 'JSON类型'
|
|
||||||
PRIMARY KEY (`id`)
|
|
||||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='示例表';
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
# 代码编写规范
|
|
||||||
|
|
||||||
| 类目 | 使用原则 | 描述 |
|
|
||||||
|:--- | :--- | :--- |
|
|
||||||
| 异步任务工单 | 适当应用 | 阅读文档[worksheet.md](../references/worksheet.md)，拿捏不准请询问用户是否要使用。 |
|
|
||||||
| JDK11~21的新特性 | 积极使用 | 局部变量类型推断、Switch表达式、模式匹配、文本块、记录类、虚拟线程。<br/>**虚拟线程应当用于IO密集型的任务，而不是CPU密集型任务。**|
|
|
||||||
| 设计模式 | 非常看重 | 为了降低代码耦合度，提高可维护性。<br/>请积极的采用工厂、模板、策略、发布订阅等常用的设计模式。<br/>一个Java源文件的代码行数不得超过**300**行，超出则拆成多个文件。<br/>一个方法体内的行数不得超过**20**行，超出则拆成多个方法。<br/>对于发布订阅模式，请根据以下情况判断：<br/>跨服务通信、集群实例广播消息，优先使用RocketMQ消息队列。<br/>进程内通信则使用`ApplicationEventPublisher`和`@EventListener`即可。|
|
|
||||||
| Lombok注解 | 积极使用 | 无需担心编译速度被拖慢。|
|
|
||||||
| Null值处理 | 适当应用 | 优先考虑`Optional.ofNullable(obj)`而不是`if (obj == null)` |
|
|
||||||
| Stream | 积极使用 | 优先使用Stream而不是循环，若map代码块超过5行就单独写一个方法。<br/>如果需要中间对象则优先使用记录类，记录类和DTO存放在一个目录。|
|
|
||||||
| 工具类 | 积极使用 | 优先采纳hutool，除非hutool没有提供才新建一个工具类。|
|
|
||||||
| 构建对象 | 非常看重 | 构建JavaBean对象，优先使用构造函数而不是单独写工具类或方法。<br/>只有3个以内的属性，应提供一个全部参数的构造函数。|
|
|
||||||
| List | 适当应用 | 在非多线程场景，默认用`ArrayList`。<br/>有需要按照插入顺序遍历元素的场景，使用`LinkedList`。<br/>需考虑线程安全用`CopyOnWriteArrayList`。|
|
|
||||||
| Set | 适当应用 | 在非多线程场景，默认用`HashSet`。<br/>按照插入顺序遍历元素的场景用`LinkedHashSet`。<br/>有排序的需求则使用`TreeSet`。<br/>需考虑线程安全用：<br/>`cn.hutool.core.collection.ConcurrentHashSet`<br/>`ConcurrentSkipListSet`<br/>`CopyOnWriteArraySet`|
|
|
||||||
| Map | 适当应用 | 在非线程场景，默认用`HashMap`。<br/>对排序要求考虑用LinkedHashMap或TreeMap。<br/>如果存在并发场景，用`ConcurrentHashMap`或`ConcurrentSkipListMap`。|
|
|
||||||
| Queue | 适当应用 | 要控制内存，用`ArrayBlockingQueue`。<br/>经典生产者消费者，用`LinkedBlockingQueue`。<br/>要窃取任务，用`LinkedBlockingDeque`。<br/>追求极致吞吐且不怕队列暴涨，用`ConcurrentLinkedQueue`。<br/>必须双端且高吞吐，用`ConcurrentLinkedDeque`。|
|
|
||||||
| Lock | 适当应用 | 分布式锁使用`Redisson`相关API<br/>单机使用`ReentrantLock`、`StampedLock`。|
|
|
||||||
|
|
||||||
## 实体类与MySQL字段类型映射规则
|
|
||||||
|
|
||||||
|实体类字段类型|MySQL字段类型|
|
|
||||||
| --- | --- |
|
|
||||||
| String | VARCHAT(255) |
|
|
||||||
| Long | BIGINT |
|
|
||||||
| Integer | INT |
|
|
||||||
| LocalDate | DATE |
|
|
||||||
| LocalDateTime | DATETIME |
|
|
||||||
| BigDecimal | DECIMAL(14, 2) |
|
|
||||||
|
|
||||||
- 数据库表结构字段名称、实体类字段名称，采用驼峰与下划线映射的方式。
|
|
||||||
- `@TableField`注解中`typeHandler`等于`JacksonTypeHandler.class`时，表结构字段默认JSON类型。
|
|
||||||
- 实体类字段包含`@NotNull`注解，需要结合`@Schema`注解中的`defaultValue`属性判断是否需要设置默认值。
|
|
||||||
- 主键列是否采用MySQL自增序列，取决于实体类被`@TableId`注解修饰的字段，要看其`type`属性，如果是`IdType.AUTO`则使用自增，否则不需要。
|
|
||||||
- 如果`@Schema`注解指定了`maxLength`属性，按如下原则设置字段类型：
|
|
||||||
- 数值小于或等于2000，使用VARCHAR
|
|
||||||
- 数值大于2000且小于10000，使用TEXT
|
|
||||||
- 数值大于10000，使用LONGTEXT
|
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
- Java：OpenJDK21
|
|
||||||
- spring-boot：
|
|
||||||
- 版本：3.2.9
|
|
||||||
- 文档：https://docs.spring.io/spring-boot/docs/3.2.9/reference/html
|
|
||||||
- 源码：https://github.com/spring-projects/spring-boot/tree/v3.2.9
|
|
||||||
- spring-framework：
|
|
||||||
- 版本：6.1.12
|
|
||||||
- 文档：https://docs.spring.io/spring-framework/reference/6.2/index.html
|
|
||||||
- 源码：https://github.com/spring-projects/spring-framework/tree/v6.1.12
|
|
||||||
- mybatis-plus：
|
|
||||||
- 版本：3.5.7
|
|
||||||
- 文档：https://github.com/baomidou/mybatis-plus-doc
|
|
||||||
- 源码：https://github.com/baomidou/mybatis-plus/tree/v3.5.7
|
|
||||||
- MySQL：
|
|
||||||
- 版本：8.0.25
|
|
||||||
- 文档：https://dev.mysql.com/doc/refman/8.0/en/
|
|
||||||
- 源码：https://github.com/mysql/mysql-server/tree/mysql-8.0.25
|
|
||||||
- Redis：8.0+
|
|
||||||
- hutool-core：
|
|
||||||
- 版本：5.8.42
|
|
||||||
- 文档：https://github.com/chinabugotech/hutool-site/tree/master/docs/core
|
|
||||||
- 源码：https://github.com/chinabugotech/hutool/tree/5.8.42/hutool-core
|
|
||||||
- hutool-json：
|
|
||||||
- 版本：5.8.42
|
|
||||||
- 文档：https://github.com/chinabugotech/hutool-site/tree/master/docs/json
|
|
||||||
- 源码：https://github.com/chinabugotech/hutool/tree/5.8.42/hutool-json
|
|
||||||
- spring-cloud-alibaba：
|
|
||||||
- 版本：2023.0.1.2
|
|
||||||
- 文档：https://sca.aliyun.com/docs/2023/overview/version-explain
|
|
||||||
- 源码：https://github.com/alibaba/spring-cloud-alibaba/tree/2023.0.1.2
|
|
||||||
- RocketMQ：
|
|
||||||
- 文档：https://rocketmq.apache.org/zh/docs/4.x
|
|
||||||
- rocketmq-client：
|
|
||||||
- 版本：4.9.8
|
|
||||||
- 源码：https://github.com/apache/rocketmq/tree/rocketmq-all-4.9.8
|
|
||||||
- rocketmq-spring-boot-starter：
|
|
||||||
- 版本：2.2.3
|
|
||||||
- 源码：https://github.com/apache/rocketmq-spring/tree/rocketmq-spring-all-2.2.3
|
|
||||||
- elasticsearch：
|
|
||||||
- 版本：9.2.0
|
|
||||||
- 文档：https://github.com/elastic/elasticsearch/tree/v9.2.0/docs
|
|
||||||
- 源码：https://github.com/elastic/elasticsearch/tree/v9.2.0
|
|
||||||
@@ -1,92 +0,0 @@
|
|||||||
# 目录结构说明
|
|
||||||
|
|
||||||
一个标准的MVC三层目录结构示例：
|
|
||||||
|
|
||||||
```text
|
|
||||||
com/example/project/
|
|
||||||
│
|
|
||||||
├── controller/ # 控制器层（接收请求）
|
|
||||||
│ ├── UserController.java
|
|
||||||
│ └── ...
|
|
||||||
│
|
|
||||||
├── service/ # 业务逻辑层
|
|
||||||
│ ├── UserService.java # 接口
|
|
||||||
│ ├── impl/ # 实现类
|
|
||||||
│ │ └── UserServiceImpl.java
|
|
||||||
│ └── ...
|
|
||||||
│
|
|
||||||
├── mapper/ # 数据访问层（MyBatis Mapper）
|
|
||||||
│ ├── ProductMapper.java
|
|
||||||
│ └── ...
|
|
||||||
│
|
|
||||||
├── domain/ # 领域层（聚合所有数据对象）
|
|
||||||
│ ├── entity/ # 实体类（与数据库表对应）
|
|
||||||
│ │ ├── Product.java
|
|
||||||
│ │ └── ...
|
|
||||||
│ │
|
|
||||||
│ ├── dto/ # 数据传输对象（输入参数）
|
|
||||||
│ │ ├── ProductQueryDTO.java
|
|
||||||
│ │ └── ...
|
|
||||||
│ │
|
|
||||||
│ └── vo/ # 视图对象（输出结果）
|
|
||||||
│ ├── UserVO.java
|
|
||||||
│ ├── ProductVO.java
|
|
||||||
│ ├── PageVO.java # 分页结果封装
|
|
||||||
│ └── ...
|
|
||||||
│
|
|
||||||
├── config/ # 配置类
|
|
||||||
│ ├── DataSourceConfig.java
|
|
||||||
│ └── ...
|
|
||||||
│
|
|
||||||
├── utils/ # 工具类
|
|
||||||
│ ├── DateUtil.java
|
|
||||||
│ └── ...
|
|
||||||
│
|
|
||||||
├── constants/ # 常量类
|
|
||||||
│ ├── StatusCode.java
|
|
||||||
│ └── ...
|
|
||||||
│
|
|
||||||
├── enums/ # 枚举类
|
|
||||||
│ ├── ResultCodeEnum.java
|
|
||||||
│ └── ...
|
|
||||||
│
|
|
||||||
└── Application.java # 启动类
|
|
||||||
```
|
|
||||||
|
|
||||||
## MVC各层职责说明
|
|
||||||
|
|
||||||
| 包名 | 职责 | 关键注解 | 典型类名示例 |
|
|
||||||
|------|------|----------|-------------|
|
|
||||||
| **controller** | 接收HTTP请求，参数校验，调用Service层，返回VO给前端 | `@RestController`<br>`@RequestMapping`<br>`@Validated` | `UserController.java` |
|
|
||||||
| **service** | 业务逻辑处理，事务管理，调用Mapper层，组装数据 | `@Service`<br>`@Transactional` | `UserService.java`（接口）<br>`UserServiceImpl.java`（实现） |
|
|
||||||
| **mapper** | 数据库CRUD操作，SQL映射，与数据库交互 | `@Mapper`<br>`@Repository`| `UserMapper.java` |
|
|
||||||
| **domain/entity** | 数据库表映射实体，与表结构一一对应 | `@TableName`（MyBatis-Plus）| `User.java` |
|
|
||||||
| **domain/dto** | 接口输入参数对象，用于接收前端请求数据，可添加校验注解 | `@Data`<br>`@NotBlank`/`@NotNull`等校验注解 | `ProductQueryDTO.java` |
|
|
||||||
| **domain/vo** | 接口输出结果对象，用于返回前端展示数据，过滤敏感字段 | `@Data`<br>无业务注解 |`ProductVO.java` |
|
|
||||||
| **config** | 配置类 | `@Configuration`<br>`@Bean` | `DataSourceConfig.java`|
|
|
||||||
| **utils** | 通用工具类，提供各种辅助方法 | 无注解 | `DateUtil.java` |
|
|
||||||
| **constants** | 常量定义，统一管理常量值 | 无注解 | `Constants.java` |
|
|
||||||
| **enums** | 枚举类型定义，管理固定状态码、类型等 | `@Enum` |`ResultCodeEnum.java` |
|
|
||||||
| **Application** | 项目启动类，Spring Boot应用入口 | `@SpringBootApplication`<br>`@MapperScan` | `Application.java` |
|
|
||||||
|
|
||||||
## 各层调用关系图
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
flowchart LR
|
|
||||||
subgraph 调用链
|
|
||||||
Controller -->|依赖调用| Service
|
|
||||||
Service -->|依赖调用| Mapper
|
|
||||||
Mapper -->|依赖调用| Database
|
|
||||||
end
|
|
||||||
|
|
||||||
subgraph 数据对象
|
|
||||||
DTO[DTO<br/>输入参数]
|
|
||||||
VO[VO<br/>输出结果]
|
|
||||||
Entity[Entity<br/>实体对象]
|
|
||||||
end
|
|
||||||
|
|
||||||
Controller -.->|接收| DTO
|
|
||||||
Controller -.->|返回| VO
|
|
||||||
Service -.->|转换| Entity
|
|
||||||
Mapper -.->|操作| Entity
|
|
||||||
```
|
|
||||||
@@ -1,46 +0,0 @@
|
|||||||
按步骤一步步执行：
|
|
||||||
|
|
||||||
1. 从**项目根目录**的`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格式。
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
从**项目根目录**`pom.xml`文件中获取查看`profiles`标签内容，类似如下片段：
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<profile>
|
|
||||||
<id>dev</id>
|
|
||||||
<properties>
|
|
||||||
<profiles.active>lab</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>
|
|
||||||
</properties>
|
|
||||||
</profile>
|
|
||||||
```
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
# 使用场景
|
|
||||||
|
|
||||||
凡是**异步且对延迟时间不敏感的任务**一律使用工单，如果不确定则向用户询问是否要使用工单。
|
|
||||||
|
|
||||||
## 前置条件
|
|
||||||
|
|
||||||
请先在编写代码的模块，检查是否存在`WorkSheetHandler.java`或者`SimpleWorkSheet.java`类，若存在则直接使用工单，不存在则不使用工单。
|
|
||||||
|
|
||||||
## 使用案例
|
|
||||||
|
|
||||||
调用方使用`tryOrderCreate`方法，遇到异常将自动处理重试逻辑。
|
|
||||||
|
|
||||||
```java
|
|
||||||
|
|
||||||
import lombok.RequiredArgsConstructor;
|
|
||||||
import lombok.extern.slf4j.Slf4j;
|
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
@Slf4j
|
|
||||||
@Component
|
|
||||||
@RequiredArgsConstructor
|
|
||||||
public class WorksheetExample implements SimpleWorkSheet {
|
|
||||||
|
|
||||||
private final WorkSheetHandler workSheetHandler;
|
|
||||||
|
|
||||||
public void tryOrderCreate(String taskId, ExampleDTO param) {
|
|
||||||
try {
|
|
||||||
createOrder(param);
|
|
||||||
} catch (Exception e) {
|
|
||||||
log.error("do_something_err", e);
|
|
||||||
workSheetHandler.putObjectParam(getWorkCode(), taskId, param);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private void createOrder(ExampleDTO param) {
|
|
||||||
// do something
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public String getWorkCode() {
|
|
||||||
return "ORDER_CREATE";
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public Object execute(WorkSheetEntity workSheet) {
|
|
||||||
createOrder(workSheet.readBeanParam(ExampleDTO.class));
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
```
|
|
||||||
Reference in new issue
Block a user