@llryiop/avatar-boot-cli 1.0.0

package/templates/README.md

@@ -0,0 +1,303 @@
+# avatar-template
+
+## 介绍
+
+该服务做为虚拟人服务端公用脚手架模板，包括通用功能模块（avatar-scaffold-api）和项目工程模板（avatar-scaffold-service）两个模块。
+
+## 依赖
+优先使用部门底层sdk框架,
+
+### 使用说明
+
+在根目录pom.xml文件中引用依赖
+
+### 方式一：通过 Parent 接入（推荐）
+
+适用于新项目或可以修改父 POM 的项目。
+
+```xml
+<project>
+    <parent>
+        <groupId>com.iflytek.avatar.boot</groupId>
+        <artifactId>avatar-boot-parent</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+    </parent>
+
+    <groupId>com.example</groupId>
+    <artifactId>your-service</artifactId>
+    <version>1.0.0</version>
+
+    <dependencies>
+        <!-- 直接引入 starter，无需指定版本 -->
+        <dependency>
+            <groupId>com.iflytek.avatar.boot</groupId>
+            <artifactId>avatar-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.iflytek.avatar.boot</groupId>
+            <artifactId>avatar-boot-starter-mysql</artifactId>
+        </dependency>
+    </dependencies>
+</project>
+```
+
+**自动获得的公共依赖：**
+
+继承 `avatar-boot-parent` 后，你的项目会自动拥有以下依赖，无需手动声明：
+
+| 依赖 | 说明 | Scope |
+|------|------|-------|
+| Lombok | 简化 Java 代码（@Data, @Slf4j 等） | compile (optional) |
+| Hutool | 常用工具类库 | compile |
+| Fastjson2 | 高性能 JSON 处理 | compile |
+| Commons Lang3 | 字符串、数组等工具 | compile |
+| Commons Collections4 | 集合工具类 | compile |
+| Spring Boot Configuration Processor | 配置属性提示 | compile (optional) |
+| Spring Boot Starter Test | 测试框架（JUnit 5, Mockito, AssertJ） | test |
+| JUnit Jupiter | 单元测试框架 | test |
+| Mockito | Mock 测试框架 | test |
+| AssertJ | 流式断言库 | test |
+
+这意味着你可以直接使用：
+- `@Data`, `@Slf4j`, `@Builder` 等 Lombok 注解
+- `StrUtil`, `CollUtil`, `DateUtil` 等 Hutool 工具类
+- `JSON.parseObject()`, `JSON.toJSONString()` 等 Fastjson2 方法
+- `StringUtils`, `ArrayUtils` 等 Commons 工具类
+- `@Test`, `@Mock`, `assertThat()` 等测试注解和方法
+
+### 方式二：通过 DependencyManagement 接入
+
+适用于已有父 POM 的项目，或需要保持现有项目结构的场景。
+
+```xml
+<project>
+    <parent>
+        <!-- 保留你原有的 parent -->
+        <groupId>com.example</groupId>
+        <artifactId>your-parent</artifactId>
+        <version>1.0.0</version>
+    </parent>
+
+    <dependencyManagement>
+        <dependencies>
+            <!-- 导入 Avatar Boot 依赖管理 -->
+            <dependency>
+                <groupId>com.iflytek.avatar.boot</groupId>
+                <artifactId>avatar-boot-dependency</artifactId>
+                <version>1.0.0-SNAPSHOT</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+    <dependencies>
+        <!-- 引入 starter，无需指定版本 -->
+        <dependency>
+            <groupId>com.iflytek.avatar.boot</groupId>
+            <artifactId>avatar-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.iflytek.avatar.boot</groupId>
+            <artifactId>avatar-boot-starter-redis</artifactId>
+        </dependency>
+
+        <!-- 需要手动添加公共依赖 -->
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>cn.hutool</groupId>
+            <artifactId>hutool-all</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.alibaba.fastjson2</groupId>
+            <artifactId>fastjson2</artifactId>
+        </dependency>
+    </dependencies>
+</project>
+```
+
+## 可用的 Starter 模块
+
+| Starter                      | 功能说明 |
+|------------------------------|---------|
+| avatar-boot-core             | 核心工具类和基础功能 |
+| avatar-boot-starter-web      | Web 应用支持（含 Knife4j API 文档） |
+| avatar-boot-starter-nacos    | Nacos 服务发现和配置中心 |
+| avatar-boot-starter-redis    | Redis 集成（含 Redisson） |
+| avatar-boot-starter-mysql    | MySQL 数据库集成（含 MyBatis Plus） |
+| avatar-boot-starter-kafka    | Kafka 消息队列集成 |
+| avatar-boot-starter-rocketmq | rocketmq 消息队列集成 |
+| avatar-boot-starter-oss      | 对象存储服务集成 |
+| avatar-boot-starter-feign    | Feign HTTP 客户端集成 |
+| avatar-boot-ai               | AI 相关功能集成 |
+
+## 项目架构规范
+
+### 目录结构原则
+
+**核心原则：按功能垂直划分，各功能完全隔离**
+
+项目采用 API + Service 双模块结构，每个功能模块在两个工程中都有对应的独立包结构：
+
+```
+avatar-scaffold-project/
+├── avatar-scaffold-api/                      # API 模块（接口定义）
+│   └── src/main/java/com/iflytek/avatar/
+│       ├── common/                            # 公共模块（跨功能共享）
+│       │   ├── constant/                      # 系统级常量
+│       │   │   └── ApiConstant.java
+│       │   ├── enums/                          # 公共枚举
+│       │   │   └── ResultCodeEnum.java
+│       │   ├── exception/                       # 公共异常
+│       │   │   ├── BusinessException.java
+│       │   │   └── ErrorCode.java
+│       │   └── dto/                             # 公共DTO
+│       │       ├── PageRequest.java             # 分页请求基类
+│       │       └── PageResponse.java            # 分页响应基类
+│       │
+│       ├── login/                               # 登录功能模块
+│       │   ├── api/                             # Feign接口定义
+│       │   │   └── LoginFeignClient.java
+│       │   ├── constant/                         # 模块常量
+│       │   │   └── LoginConstant.java
+│       │   ├── enums/                            # 模块枚举
+│       │   │   └── LoginTypeEnum.java
+│       │   ├── exception/                         # 模块异常
+│       │   │   └── LoginException.java
+│       │   └── dto/                               # **DTO目录（统一命名）**
+│       │       ├── request/                       # 请求DTO
+│       │       │   ├── LoginRequest.java
+│       │       │   └── RefreshTokenRequest.java
+│       │       └── response/                      # 响应DTO
+│       │           ├── LoginResponse.java
+│       │           └── TokenInfoResponse.java
+│       │
+│       └── user/                                 # 用户功能模块
+│           ├── api/
+│           │   └── UserFeignClient.java
+│           ├── constant/
+│           │   └── UserConstant.java
+│           ├── enums/
+│           │   └── UserStatusEnum.java
+│           ├── exception/
+│           │   └── UserException.java
+│           └── dto/
+│               ├── request/
+│               │   ├── CreateUserRequest.java
+│               │   ├── UpdateUserRequest.java
+│               │   └── UserQueryRequest.java
+│               └── response/
+│                   ├── UserDetailResponse.java
+│                   └── UserSimpleResponse.java
+│
+└── avatar-scaffold-service/                   # Service 模块（业务实现）
+    └── src/main/java/com/iflytek/avatar/
+        ├── common/                              # 公共实现
+        │   ├── config/                           # 全局配置
+        │   │   ├── MyBatisConfig.java
+        │   │   ├── RedisConfig.java
+        │   │   └── SwaggerConfig.java
+        │   ├── utils/                             # 公共工具类
+        │   │   ├── JwtUtils.java
+        │   │   └── RedisUtils.java
+        │   └── interceptor/                       # 全局拦截器
+        │       └── LoginInterceptor.java
+        │
+        ├── login/                                 # 登录功能实现
+        │   ├── config/                             # 模块配置
+        │   │   └── LoginConfig.java
+        │   ├── controller/                          # REST控制器（实现API）
+        │   │   └── LoginController.java
+        │   ├── service/                             # 业务逻辑层
+        │   │   ├── LoginService.java               # 接口
+        │   │   └── impl/
+        │   │       └── LoginServiceImpl.java       # 实现
+        │   ├── repository/                          # **数据访问层（使用repository）**
+        │   │   ├── mapper/                          # MyBatis Mapper接口
+        │   │   │   └── UserLoginMapper.java
+        │   │   └── entity/                          # **数据库实体（统一用entity）**
+        │   │       ├── UserLoginEntity.java        # 用户登录表实体
+        │   │       └── UserTokenEntity.java        # 用户Token表实体
+        │   ├── converter/                           # **对象转换器（DO <-> DTO）**
+        │   │   └── LoginConverter.java
+        │   └── utils/                               # 模块工具类
+        │       └── LoginUtils.java
+        │
+        └── user/                                    # 用户功能实现
+            ├── controller/
+            │   └── UserController.java
+            ├── service/
+            │   ├── UserService.java
+            │   └── impl/
+            │       └── UserServiceImpl.java
+            ├── repository/
+            │   ├── mapper/
+            │   │   └── UserMapper.java
+            │   └── entity/
+            │       ├── UserEntity.java             # 用户主表实体
+            │       └── UserProfileEntity.java      # 用户档案表实体
+            ├── converter/
+            │   └── UserConverter.java
+            └── validator/                           # **参数校验器**
+                └── UserValidator.java
+```
+
+### 架构规则
+
+1. **功能隔离**：每个业务功能（如 login、user）都有独立的包结构，功能之间完全隔离
+2. **垂直划分**：功能包内包含该功能的所有层次（controller、service、dao、entity），避免水平分层
+3. **API 分离**：API 模块只包含接口定义和数据传输对象（DTO），不包含业务逻辑
+4. **Service 实现**：Service 模块包含具体的业务逻辑实现，实现 API 模块定义的接口
+5. **统一返回格式**：所有 API 接口必须使用 `avatar-boot-core` 包中的 `Result<T>` 类作为返回类型，确保响应格式统一
+
+### 包结构说明
+
+**API 模块包结构**（avatar-scaffold-api）：
+- `api/` - 接口定义（供外部调用的 REST API 接口）
+- `constant/` - 常量定义（业务常量、配置常量）
+- `enums/` - 枚举定义（业务枚举类型）
+- `exception/` - 异常定义（业务异常类）
+- `entity/request/` - 请求参数实体（DTO，用于接收客户端请求）
+- `entity/response/` - 响应结果实体（DTO，必须使用 `Result<T>` 包装）
+- `feign/` - Feign 客户端（用于服务间调用，基于 `avatar-boot-starter-feign`）
+
+**Service 模块包结构**（avatar-scaffold-service）：
+- `config/` - 配置类（Spring 配置、Bean 定义）
+- `controller/` - REST 控制器（实现 API 接口，所有方法返回 `Result<T>`）
+- `service/` - 业务逻辑层（Service 接口和实现类）
+- `dao/` - 数据访问层（MyBatis Mapper 接口）
+- `dao/beans/` - 数据库实体类（DO/PO，对应数据库表结构）
+- `utils/` - 工具类（功能模块内部使用的工具方法）
+
+**Result 类使用规范**：
+- 所有 Controller 方法必须返回 `com.iflytek.avatar.boot.entity.response.Result<T>` 类型
+- 成功响应：`Result.success(data)` 或 `Result.success()`
+- 失败响应：`Result.fail(errorCode, errorMessage)` 或 `Result.fail(errorMessage)`
+- Response DTO 作为泛型参数：`Result<UserResponse>`
+- 统一的响应格式确保前后端接口规范一致
+
+### 新增功能开发流程
+
+当需要添加新功能时，按照以下步骤进行：
+
+1. **在 API 模块创建功能包**：`com.iflytek.avatar.{功能名}`
+   - 创建 `api/` 目录，定义接口
+   - 创建 `entity/request/` 和 `entity/response/` 目录，定义 DTO
+   - 创建 `feign/` 目录，定义 Feign 客户端
+   - 创建 `constant/` 目录，定义常量
+   - 创建 `enums/` 目录，定义枚举
+   - 创建 `exception/` 目录，定义错误定义
+   - 创建 `utils/` 目录，定义工具类
+
+2. **在 Service 模块创建功能包**：`com.iflytek.avatar.{功能名}`
+   - 创建 `controller/` 目录，实现 REST 接口
+   - 创建 `service/` 目录，实现业务逻辑
+   - 创建 `dao/` 目录，实现数据访问
+   - 创建 `config/` 目录，定义配置类
+   - 创建 `utils/` 目录，定义数据库实体
+
+3. **保持功能独立**：不同功能之间通过 Feign 客户端或消息队列进行通信，避免直接依赖

package/templates/avatar-scaffold-api/pom.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>com.iflytek.avatar</groupId>
+        <artifactId>avatar-template</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+
+    <artifactId>avatar-template-api</artifactId>
+
+    <properties>
+        <maven.compiler.source>21</maven.compiler.source>
+        <maven.compiler.target>21</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.iflytek.avatar.boot</groupId>
+            <artifactId>avatar-boot-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.iflytek.avatar.boot</groupId>
+            <artifactId>avatar-boot-starter-feign</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>jakarta.validation</groupId>
+            <artifactId>jakarta.validation-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <optional>true</optional>
+        </dependency>
+    </dependencies>
+
+</project>

package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/api/LoginFeignClient.java

@@ -0,0 +1,40 @@
+package com.iflytek.avatar.login.api;
+
+import com.iflytek.avatar.boot.entity.response.Result;
+import com.iflytek.avatar.login.dto.request.LoginRequest;
+import com.iflytek.avatar.login.dto.request.RefreshTokenRequest;
+import com.iflytek.avatar.login.dto.response.LoginResponse;
+import com.iflytek.avatar.login.dto.response.TokenInfoResponse;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+
+/**
+ * 登录服务 Feign 客户端。
+ * 供其他微服务通过 Feign 调用登录相关接口。
+ */
+@FeignClient(
+    name = "avatar-scaffold-service",
+    path = "/api/login",
+    configuration = com.iflytek.avatar.boot.config.FeignLoggingConfiguration.class
+)
+public interface LoginFeignClient {
+
+    /**
+     * 用户登录
+     *
+     * @param request 登录请求（用户名、密码等）
+     * @return 登录结果，包含 token 与用户信息
+     */
+    @PostMapping("/login")
+    Result<LoginResponse> login(@RequestBody LoginRequest request);
+
+    /**
+     * 刷新 Token
+     *
+     * @param request 刷新请求（refreshToken）
+     * @return 新的 Token 信息
+     */
+    @PostMapping("/refresh")
+    Result<TokenInfoResponse> refreshToken(@RequestBody RefreshTokenRequest request);
+}

package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/constant/LoginConstant.java

@@ -0,0 +1,21 @@
+package com.iflytek.avatar.login.constant;
+
+/**
+ * 登录模块常量
+ */
+public final class LoginConstant {
+
+    private LoginConstant() {}
+
+    /** 默认 Token 过期时间（秒） */
+    public static final int DEFAULT_TOKEN_EXPIRE_SECONDS = 7200;
+
+    /** 刷新 Token 过期时间（秒） */
+    public static final int REFRESH_TOKEN_EXPIRE_SECONDS = 604800;
+
+    /** 请求头：Authorization */
+    public static final String HEADER_AUTHORIZATION = "Authorization";
+
+    /** Bearer 前缀 */
+    public static final String BEARER_PREFIX = "Bearer ";
+}

package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/dto/request/LoginRequest.java

@@ -0,0 +1,17 @@
+package com.iflytek.avatar.login.dto.request;
+
+import jakarta.validation.constraints.NotBlank;
+import lombok.Data;
+
+/**
+ * 登录请求 DTO
+ */
+@Data
+public class LoginRequest {
+
+    @NotBlank(message = "用户名不能为空")
+    private String username;
+
+    @NotBlank(message = "密码不能为空")
+    private String password;
+}

package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/dto/request/RefreshTokenRequest.java

@@ -0,0 +1,14 @@
+package com.iflytek.avatar.login.dto.request;
+
+import jakarta.validation.constraints.NotBlank;
+import lombok.Data;
+
+/**
+ * 刷新 Token 请求 DTO
+ */
+@Data
+public class RefreshTokenRequest {
+
+    @NotBlank(message = "refreshToken 不能为空")
+    private String refreshToken;
+}

package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/dto/response/LoginResponse.java

@@ -0,0 +1,31 @@
+package com.iflytek.avatar.login.dto.response;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * 登录响应 DTO
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class LoginResponse {
+
+    /** 访问令牌 */
+    private String token;
+
+    /** 刷新令牌 */
+    private String refreshToken;
+
+    /** 用户 ID */
+    private Long userId;
+
+    /** 用户名 */
+    private String username;
+
+    /** 过期时间戳（毫秒） */
+    private Long expireTime;
+}

package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/dto/response/TokenInfoResponse.java

@@ -0,0 +1,25 @@
+package com.iflytek.avatar.login.dto.response;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * Token 信息响应 DTO（用于刷新 Token 等场景）
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class TokenInfoResponse {
+
+    /** 新的访问令牌 */
+    private String token;
+
+    /** 新的刷新令牌 */
+    private String refreshToken;
+
+    /** 过期时间戳（毫秒） */
+    private Long expireTime;
+}

package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/enums/LoginTypeEnum.java

@@ -0,0 +1,23 @@
+package com.iflytek.avatar.login.enums;
+
+import lombok.Getter;
+
+/**
+ * 登录方式枚举
+ */
+@Getter
+public enum LoginTypeEnum {
+
+    PASSWORD(1, "密码登录"),
+    SMS(2, "短信验证码登录"),
+    WECHAT(3, "微信登录"),
+    ;
+
+    private final int code;
+    private final String desc;
+
+    LoginTypeEnum(int code, String desc) {
+        this.code = code;
+        this.desc = desc;
+    }
+}

package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/exception/LoginException.java

@@ -0,0 +1,23 @@
+package com.iflytek.avatar.login.exception;
+
+/**
+ * 登录模块业务异常
+ */
+public class LoginException extends RuntimeException {
+
+    private final int code;
+
+    public LoginException(String message) {
+        super(message);
+        this.code = 400;
+    }
+
+    public LoginException(int code, String message) {
+        super(message);
+        this.code = code;
+    }
+
+    public int getCode() {
+        return code;
+    }
+}

package/templates/avatar-scaffold-service/k8s-app/Dockerfile

@@ -0,0 +1,14 @@
+FROM artifacts.iflytek.com/cbg-docker-private/yspt/open-jdk:21
+
+ARG BUILD_ENV
+ARG APP_NAME
+
+# 设置默认环境变量
+ENV JAVA_OPTS="-Xms512m -Xmx512m" \
+    SPRING_PROFILES_ACTIVE=${BUILD_ENV} \
+    TZ="Asia/Shanghai"
+ADD ${APP_NAME}/target/${APP_NAME}*.tar.gz /data/server/
+WORKDIR /data/server/${APP_NAME}
+RUN chmod +x ./bin/startup.sh
+
+ENTRYPOINT ["sh", "-c", "./bin/startup.sh --spring.profiles.active=${SPRING_PROFILES_ACTIVE}"]

package/templates/avatar-scaffold-service/k8s-app/Dockerfile-arm64

@@ -0,0 +1,14 @@
+FROM artifacts.iflytek.com/cbg-docker-private/yspt/openjdk:21-linuxarm64
+
+ARG BUILD_ENV
+ARG APP_NAME
+
+# 设置默认环境变量
+ENV JAVA_OPTS="-Xms512m -Xmx512m" \
+    SPRING_PROFILES_ACTIVE=${BUILD_ENV} \
+    TZ="Asia/Shanghai"
+ADD ${APP_NAME}/target/${APP_NAME}*.tar.gz /data/server/
+WORKDIR /data/server/${APP_NAME}
+RUN chmod +x ./bin/startup.sh
+
+ENTRYPOINT ["sh", "-c", "./bin/startup.sh --spring.profiles.active=${SPRING_PROFILES_ACTIVE}"]

package/templates/avatar-scaffold-service/packaging/assembly.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<assembly>
+	<id>releases</id>
+	<baseDirectory>avatar-template-service</baseDirectory>
+	<formats>
+		<format>zip</format>
+		<format>tar.gz</format>
+	</formats>
+	<includeBaseDirectory>true</includeBaseDirectory>
+	<fileSets>
+		<fileSet>
+			<directory>target/appassembler</directory>
+			<outputDirectory>./</outputDirectory>
+		</fileSet>
+	</fileSets>
+</assembly>