API文档访问验证

commit cace369da2bd11c76f02a5898814ee8ec07111bd Author: wangys <3401275564@qq.com> Date: Fri Feb 13 17:15:00 2026 +0800 first commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b81fe1f --- /dev/null +++ b/.gitignore @@ -0,0 +1,40 @@ +# Maven +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +pom.xml.next +release.properties + +# IDE +.idea/ +*.iml +*.ipr +*.iws +.project +.classpath +.settings/ +.vscode/ + +# Logs +logs/ +*.log + +# OS +.DS_Store +Thumbs.db + +# Build +build/ +out/ + +# Temp +*.tmp +*.bak +*.swp + +# 敏感配置文件（本地环境配置不要提交） +application-local.yml +application-local.properties +*-local.yml +*-local.properties diff --git a/README.md b/README.md new file mode 100644 index 0000000..c3501ac --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# 1818AI 微信小程序后端服务 + +## 项目简介 + +基于 Spring Boot 的微信小程序后端服务。 + +## 技术栈 + +- Java +- Spring Boot +- Maven + +## 快速开始 + +```bash +# 安装依赖 +mvn install + +# 启动服务 +mvn spring-boot:run +``` + +## 目录结构 + +``` +├── src/ # 源代码 +├── docs/ # 文档 +├── pom.xml # Maven 配置 +└── README.md # 项目说明 +``` + +## License + +MIT diff --git a/docs/CODE_STANDARDS.md b/docs/CODE_STANDARDS.md new file mode 100644 index 0000000..8756949 --- /dev/null +++ b/docs/CODE_STANDARDS.md @@ -0,0 +1,427 @@ +# 代码开发规范 + +## 一、项目结构规范 + +``` +src/main/java/com/dora/ +├── WeixinApplication.java # 启动类 +├── common/ # 公共模块 +│ ├── constant/ # 常量定义 +│ ├── enums/ # 枚举类 +│ ├── exception/ # 异常处理 +│ └── result/ # 统一响应 +├── config/ # 配置类 +├── controller/ # 控制器层（接收请求） +├── service/ # 业务服务层 +│ └── impl/ # 服务实现 +├── mapper/ # 数据访问层 +├── entity/ # 数据库实体 +├── dto/ # 数据传输对象（入参） +├── vo/ # 视图对象（出参） +├── util/ # 工具类 +└── aspect/ # 切面 +``` + +## 二、命名规范 + +### 2.1 类命名 +| 类型 | 规范 | 示例 | +|------|------|------| +| Controller | XxxController | UserController | +| Service接口 | XxxService | UserService | +| Service实现 | XxxServiceImpl | UserServiceImpl | +| Mapper | XxxMapper | UserMapper | +| Entity | 与表名对应，驼峰 | User, AiWork | +| DTO | XxxDTO / XxxRequest | UserLoginDTO | +| VO | XxxVO | UserInfoVO | +| 枚举 | XxxEnum | UserStatusEnum | +| 常量 | XxxConstant | RedisConstant | +| 工具类 | XxxUtil | DateUtil | +| 配置类 | XxxConfig | RedisConfig | + +### 2.2 方法命名 +| 操作 | 命名规范 | 示例 | +|------|----------|------| +| 查询单个 | getXxx / findXxx | getUserById | +| 查询列表 | listXxx | listUserByStatus | +| 分页查询 | pageXxx | pageUser | +| 新增 | save / add / create | saveUser | +| 修改 | update / modify | updateUser | +| 删除 | delete / remove | deleteUser | +| 统计 | countXxx | countUserByVip | +| 判断 | isXxx / hasXxx | isVipUser | + +### 2.3 变量命名 +- 使用小驼峰：`userId`, `orderNo` +- 布尔类型：`isXxx`, `hasXxx`, `canXxx` +- 集合类型：复数形式 `users`, `orderList` +- 常量：全大写下划线分隔 `MAX_RETRY_COUNT` + +## 三、Controller规范 + +```java +@Slf4j +@RestController +@RequestMapping("/user") +@RequiredArgsConstructor +public class UserController { + + private final UserService userService; + + /** + * 获取用户信息 + * + * @param id 用户ID + * @return 用户信息 + */ + @GetMapping("/{id}") + public Result getById(@PathVariable Long id) { + return Result.success(userService.getById(id)); + } + + /** + * 分页查询用户 + */ + @GetMapping("/page") + public Result> page(UserPageDTO dto) { + return Result.success(userService.page(dto)); + } + + /** + * 新增用户 + */ + @PostMapping + public Result save(@RequestBody @Valid UserSaveDTO dto) { + return Result.success(userService.save(dto)); + } + + /** + * 更新用户 + */ + @PutMapping("/{id}") + public Result update(@PathVariable Long id, @RequestBody @Valid UserUpdateDTO dto) { + userService.update(id, dto); + return Result.success(); + } + + /** + * 删除用户 + */ + @DeleteMapping("/{id}") + public Result delete(@PathVariable Long id) { + userService.delete(id); + return Result.success(); + } +} +``` + +### Controller规则 +1. 使用 `@RequiredArgsConstructor` 构造器注入，禁止 `@Autowired` +2. 方法必须有注释说明 +3. 入参使用 DTO，出参使用 VO +4. 参数校验使用 `@Valid` +5. 统一返回 `Result` +6. 不写业务逻辑，只做参数接收和结果返回 + +## 四、Service规范 + +```java +public interface UserService { + + UserVO getById(Long id); + + IPage page(UserPageDTO dto); + + Long save(UserSaveDTO dto); + + void update(Long id, UserUpdateDTO dto); + + void delete(Long id); +} +``` + +```java +@Slf4j +@Service +@RequiredArgsConstructor +public class UserServiceImpl implements UserService { + + private final UserMapper userMapper; + private final RedisUtil redisUtil; + + @Override + public UserVO getById(Long id) { + User user = userMapper.selectById(id); + if (user == null) { + throw new BusinessException(ResultCode.USER_NOT_FOUND); + } + return convertToVO(user); + } + + @Override + @Transactional(rollbackFor = Exception.class) + public Long save(UserSaveDTO dto) { + // 1. 参数校验 + checkPhoneExists(dto.getPhone()); + + // 2. 构建实体 + User user = new User(); + BeanUtils.copyProperties(dto, user); + + // 3. 保存数据 + userMapper.insert(user); + + // 4. 返回结果 + return user.getId(); + } +} +``` + +### Service规则 +1. 接口与实现分离 +2. 事务注解加在实现类方法上：`@Transactional(rollbackFor = Exception.class)` +3. 复杂业务逻辑拆分为私有方法 +4. 异常使用 `BusinessException` 抛出 +5. 日志记录关键操作 + +## 五、Entity规范 + +```java +@Data +@TableName("user") +public class User { + + @TableId(type = IdType.AUTO) + private Long id; + + private String openid; + + private String nickname; + + private String phone; + + private Integer vipLevel; + + private LocalDateTime vipExpireTime; + + private Integer points; + + private Integer status; + + @TableField(fill = FieldFill.INSERT) + private LocalDateTime createdAt; + + @TableField(fill = FieldFill.INSERT_UPDATE) + private LocalDateTime updatedAt; + + @TableLogic + private Integer deleted; +} +``` + +### Entity规则 +1. 使用 `@Data` 简化代码 +2. 字段类型与数据库对应 +3. 时间类型使用 `LocalDateTime` +4. 逻辑删除字段使用 `@TableLogic` +5. 禁止在Entity中写业务方法 + +## 六、DTO/VO规范 + +```java +// 入参DTO +@Data +public class UserSaveDTO { + + @NotBlank(message = "手机号不能为空") + @Pattern(regexp = "^1[3-9]\\d{9}$", message = "手机号格式不正确") + private String phone; + + @NotBlank(message = "昵称不能为空") + @Size(max = 64, message = "昵称最长64个字符") + private String nickname; +} + +// 出参VO +@Data +public class UserVO { + + private Long id; + + private String nickname; + + private String avatar; + + private Integer vipLevel; + + private String vipLevelName; + + private Integer points; + + private LocalDateTime createdAt; +} +``` + +### DTO/VO规则 +1. DTO用于接收入参，必须加校验注解 +2. VO用于返回数据，可添加格式化字段 +3. 禁止直接返回Entity +4. 敏感字段（密码、token）不放入VO + +## 七、Mapper规范 + +```java +@Mapper +public interface UserMapper extends BaseMapper { + + /** + * 根据手机号查询用户 + */ + User selectByPhone(@Param("phone") String phone); + + /** + * 批量更新状态 + */ + int batchUpdateStatus(@Param("ids") List ids, @Param("status") Integer status); +} +``` + +### Mapper规则 +1. 继承 `BaseMapper` 使用通用方法 +2. 复杂SQL写在XML文件中 +3. 参数使用 `@Param` 注解 +4. 禁止在Mapper中写业务逻辑 + +## 八、异常处理规范 + +```java +// 抛出业务异常 +throw new BusinessException(ResultCode.USER_NOT_FOUND); +throw new BusinessException("自定义错误信息"); +throw new BusinessException(4001, "自定义错误码和信息"); + +// 参数校验 +if (user == null) { + throw new BusinessException(ResultCode.USER_NOT_FOUND); +} + +// 使用断言（推荐） +Assert.notNull(user, "用户不存在"); +``` + +## 九、日志规范 + +```java +@Slf4j +public class UserServiceImpl { + + public void doSomething() { + // DEBUG：调试信息 + log.debug("查询用户参数: {}", dto); + + // INFO：关键业务操作 + log.info("用户注册成功, userId={}, phone={}", user.getId(), user.getPhone()); + + // WARN：警告信息 + log.warn("用户登录失败次数过多, userId={}", userId); + + // ERROR：异常错误（带异常堆栈） + log.error("调用第三方接口失败, url={}", url, e); + } +} +``` + +### 日志规则 +1. 使用 `@Slf4j` 注解 +2. 使用占位符 `{}`，禁止字符串拼接 +3. ERROR日志必须带异常对象 +4. 敏感信息脱敏处理 + +## 十、数据库规范 + +### 10.1 连接池配置 +项目使用 HikariCP 连接池，已优化配置： +- 最小空闲连接：10 +- 最大连接数：50 +- 空闲超时：10分钟 +- 连接最大存活：30分钟 +- 泄漏检测：60秒 + +### 10.2 SQL规范 +1. 禁止 `SELECT *`，明确指定字段 +2. 大表查询必须走索引 +3. 禁止在循环中执行SQL +4. 批量操作使用 `saveBatch` +5. 分页查询必须有排序字段 + +```java +// 错误示例 +for (Long id : ids) { + userMapper.selectById(id); // N+1问题 +} + +// 正确示例 +List users = userMapper.selectBatchIds(ids); +``` + +### 10.3 事务规范 +```java +// 只读事务 +@Transactional(readOnly = true) +public UserVO getById(Long id) { } + +// 写事务 +@Transactional(rollbackFor = Exception.class) +public void save(UserDTO dto) { } +``` + +## 十一、接口规范 + +### 11.1 RESTful规范 +| 操作 | 方法 | 路径 | 示例 | +|------|------|------|------| +| 查询 | GET | /资源 | GET /users | +| 详情 | GET | /资源/{id} | GET /users/1 | +| 新增 | POST | /资源 | POST /users | +| 修改 | PUT | /资源/{id} | PUT /users/1 | +| 删除 | DELETE | /资源/{id} | DELETE /users/1 | + +### 11.2 响应格式 +```json +{ + "code": 200, + "message": "操作成功", + "data": {}, + "timestamp": 1704067200000 +} +``` + +## 十二、安全规范 + +1. 敏感配置使用环境变量或配置中心 +2. 密码使用 BCrypt 加密存储 +3. 接口做权限校验 +4. 防止SQL注入，使用参数化查询 +5. 防止XSS，对输出内容转义 +6. 日志脱敏处理敏感信息 + +## 十三、Git提交规范 + +``` +(): + +feat: 新功能 +fix: 修复bug +docs: 文档更新 +style: 代码格式 +refactor: 重构 +test: 测试 +chore: 构建/工具 +``` + +示例： +``` +feat(user): 添加用户注册功能 +fix(order): 修复订单金额计算错误 +docs(readme): 更新部署文档 +``` diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..952132a --- /dev/null +++ b/pom.xml @@ -0,0 +1,166 @@ + + + 4.0.0 + + + org.springframework.boot + spring-boot-starter-parent + 3.2.2 + + + + com.dora + weixin-backend + 1.0.0-SNAPSHOT + jar + weixin-backend + 1818AIGC微信后端服务 + + + 17 + UTF-8 + UTF-8 + 3.5.5 + 5.6.191 + 0.12.5 + + + + + + org.springframework.boot + spring-boot-starter-web + + + + + org.springframework.boot + spring-boot-starter-validation + + + + + org.springframework.boot + spring-boot-starter-jdbc + + + + + com.mysql + mysql-connector-j + runtime + + + + + com.baomidou + mybatis-plus-spring-boot3-starter + ${mybatis-plus.version} + + + + + org.springframework.boot + spring-boot-starter-data-redis + + + + + com.qcloud + cos_api + ${cos.version} + + + + + com.tencentcloudapi + tencentcloud-sdk-java-vod + 3.1.1411 + + + + + org.projectlombok + lombok + true + + + + + io.jsonwebtoken + jjwt-api + ${jjwt.version} + + + io.jsonwebtoken + jjwt-impl + ${jjwt.version} + runtime + + + io.jsonwebtoken + jjwt-jackson + ${jjwt.version} + runtime + + + + + org.springdoc + springdoc-openapi-starter-webmvc-ui + 2.3.0 + + + + + org.springframework.security + spring-security-crypto + + + + + org.springframework.boot + spring-boot-starter-aop + + + + + org.springframework.boot + spring-boot-starter-mail + + + + + com.github.binarywang + weixin-java-pay + 4.6.0 + + + + + org.springframework.boot + spring-boot-starter-test + test + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + org.projectlombok + lombok + + + + + + + + diff --git a/src/main/java/com/dora/WeixinApplication.java b/src/main/java/com/dora/WeixinApplication.java new file mode 100644 index 0000000..13ed622 --- /dev/null +++ b/src/main/java/com/dora/WeixinApplication.java @@ -0,0 +1,19 @@ +package com.dora; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.scheduling.annotation.EnableScheduling; + +/** + * 微信后端服务启动类 + * + * @author dora + */ +@SpringBootApplication +@EnableScheduling +public class WeixinApplication { + + public static void main(String[] args) { + SpringApplication.run(WeixinApplication.class, args); + } +} diff --git a/src/main/java/com/dora/annotation/RequirePermission.java b/src/main/java/com/dora/annotation/RequirePermission.java new file mode 100644 index 0000000..c4f6821 --- /dev/null +++ b/src/main/java/com/dora/annotation/RequirePermission.java @@ -0,0 +1,22 @@ +package com.dora.annotation; + +import java.lang.annotation.*; + +/** + * 权限校验注解 + */ +@Target({ElementType.METHOD, ElementType.TYPE}) +@Retention(RetentionPolicy.RUNTIME) +@Documented +public @interface RequirePermission { + + /** + * 需要的权限码 + */ + String[] value() default {}; + + /** + * 是否需要全部权限（AND逻辑），默认false（OR逻辑） + */ + boolean requireAll() default false; +} diff --git a/src/main/java/com/dora/aspect/PermissionAspect.java b/src/main/java/com/dora/aspect/PermissionAspect.java new file mode 100644 index 0000000..4494f0a --- /dev/null +++ b/src/main/java/com/dora/aspect/PermissionAspect.java @@ -0,0 +1,78 @@ +package com.dora.aspect; + +import com.dora.annotation.RequirePermission; +import com.dora.common.context.AdminContext; +import com.dora.common.exception.BusinessException; +import com.dora.common.result.ResultCode; +import com.dora.mapper.AdminMapper; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.aspectj.lang.ProceedingJoinPoint; +import org.aspectj.lang.annotation.Around; +import org.aspectj.lang.annotation.Aspect; +import org.aspectj.lang.reflect.MethodSignature; +import org.springframework.stereotype.Component; + +import java.lang.reflect.Method; +import java.util.Arrays; +import java.util.List; + +/** + * 权限校验切面 + */ +@Slf4j +@Aspect +@Component +@RequiredArgsConstructor +public class PermissionAspect { + + private final AdminMapper adminMapper; + + @Around("@annotation(com.dora.annotation.RequirePermission)") + public Object checkPermission(ProceedingJoinPoint joinPoint) throws Throwable { + // 获取注解 + MethodSignature signature = (MethodSignature) joinPoint.getSignature(); + Method method = signature.getMethod(); + RequirePermission annotation = method.getAnnotation(RequirePermission.class); + + if (annotation == null || annotation.value().length == 0) { + return joinPoint.proceed(); + } + + // 获取当前管理员ID + Long adminId = AdminContext.getAdminId(); + if (adminId == null) { + throw new BusinessException(ResultCode.UNAUTHORIZED); + } + + // 获取管理员权限 + List permissions = adminMapper.selectPermissionCodesByAdminId(adminId); + + // 超级管理员拥有所有权限 + List roles = adminMapper.selectRoleCodesByAdminId(adminId); + if (roles.contains("SUPER_ADMIN")) { + return joinPoint.proceed(); + } + + // 校验权限 + String[] requiredPermissions = annotation.value(); + boolean hasPermission; + + if (annotation.requireAll()) { + // 需要全部权限 + hasPermission = permissions.containsAll(Arrays.asList(requiredPermissions)); + } else { + // 只需要其中一个权限 + hasPermission = Arrays.stream(requiredPermissions) + .anyMatch(permissions::contains); + } + + if (!hasPermission) { + log.warn("权限不足: adminId={}, required={}, has={}", + adminId, Arrays.toString(requiredPermissions), permissions); + throw new BusinessException(ResultCode.FORBIDDEN); + } + + return joinPoint.proceed(); + } +} diff --git a/src/main/java/com/dora/common/context/AdminContext.java b/src/main/java/com/dora/common/context/AdminContext.java new file mode 100644 index 0000000..8428fca --- /dev/null +++ b/src/main/java/com/dora/common/context/AdminContext.java @@ -0,0 +1,31 @@ +package com.dora.common.context; + +/** + * 管理员上下文 + */ +public class AdminContext { + + private static final ThreadLocal ADMIN_ID = new ThreadLocal<>(); + private static final ThreadLocal USERNAME = new ThreadLocal<>(); + + public static void setAdminId(Long adminId) { + ADMIN_ID.set(adminId); + } + + public static Long getAdminId() { + return ADMIN_ID.get(); + } + + public static void setUsername(String username) { + USERNAME.set(username); + } + + public static String getUsername() { + return USERNAME.get(); + } + + public static void clear() { + ADMIN_ID.remove(); + USERNAME.remove(); + } +} diff --git a/src/main/java/com/dora/common/context/UserContext.java b/src/main/java/com/dora/common/context/UserContext.java new file mode 100644 index 0000000..b4a6a3e --- /dev/null +++ b/src/main/java/com/dora/common/context/UserContext.java @@ -0,0 +1,46 @@ +package com.dora.common.context; + +/** + * 用户上下文，存储当前请求的用户信息 + */ +public class UserContext { + + private static final ThreadLocal USER_ID = new ThreadLocal<>(); + private static final ThreadLocal OPENID = new ThreadLocal<>(); + + /** + * 设置用户ID + */ + public static void setUserId(Long userId) { + USER_ID.set(userId); + } + + /** + * 获取用户ID + */ + public static Long getUserId() { + return USER_ID.get(); + } + + /** + * 设置openid + */ + public static void setOpenid(String openid) { + OPENID.set(openid); + } + + /** + * 获取openid + */ + public static String getOpenid() { + return OPENID.get(); + } + + /** + * 清理上下文 + */ + public static void clear() { + USER_ID.remove(); + OPENID.remove(); + } +} diff --git a/src/main/java/com/dora/common/exception/BusinessException.java b/src/main/java/com/dora/common/exception/BusinessException.java new file mode 100644 index 0000000..5ce930b --- /dev/null +++ b/src/main/java/com/dora/common/exception/BusinessException.java @@ -0,0 +1,35 @@ +package com.dora.common.exception; + +import com.dora.common.result.ResultCode; +import lombok.Getter; + +/** + * 业务异常 + * + * @author dora + */ +@Getter +public class BusinessException extends RuntimeException { + + private final Integer code; + + public BusinessException(String message) { + super(message); + this.code = ResultCode.FAIL.getCode(); + } + + public BusinessException(Integer code, String message) { + super(message); + this.code = code; + } + + public BusinessException(ResultCode resultCode) { + super(resultCode.getMessage()); + this.code = resultCode.getCode(); + } + + public BusinessException(ResultCode resultCode, String message) { + super(message); + this.code = resultCode.getCode(); + } +} diff --git a/src/main/java/com/dora/common/exception/GlobalExceptionHandler.java b/src/main/java/com/dora/common/exception/GlobalExceptionHandler.java new file mode 100644 index 0000000..d9f278f --- /dev/null +++ b/src/main/java/com/dora/common/exception/GlobalExceptionHandler.java @@ -0,0 +1,78 @@ +package com.dora.common.exception; + +import com.dora.common.result.Result; +import com.dora.common.result.ResultCode; +import jakarta.validation.ConstraintViolationException; +import lombok.extern.slf4j.Slf4j; +import org.springframework.http.HttpStatus; +import org.springframework.validation.BindException; +import org.springframework.web.bind.MethodArgumentNotValidException; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.ResponseStatus; +import org.springframework.web.bind.annotation.RestControllerAdvice; + +/** + * 全局异常处理器 + * + * @author dora + */ +@Slf4j +@RestControllerAdvice +public class GlobalExceptionHandler { + + /** + * 业务异常 + */ + @ExceptionHandler(BusinessException.class) + @ResponseStatus(HttpStatus.OK) + public Result handleBusinessException(BusinessException e) { + log.warn("业务异常: {}", e.getMessage()); + return Result.fail(e.getCode(), e.getMessage()); + } + + /** + * 参数校验异常 + */ + @ExceptionHandler(MethodArgumentNotValidException.class) + @ResponseStatus(HttpStatus.BAD_REQUEST) + public Result handleValidException(MethodArgumentNotValidException e) { + String message = e.getBindingResult().getFieldError() != null + ? e.getBindingResult().getFieldError().getDefaultMessage() + : "参数校验失败"; + log.warn("参数校验异常: {}", message); + return Result.fail(ResultCode.PARAM_ERROR.getCode(), message); + } + + /** + * 绑定异常 + */ + @ExceptionHandler(BindException.class) + @ResponseStatus(HttpStatus.BAD_REQUEST) + public Result handleBindException(BindException e) { + String message = e.getFieldError() != null + ? e.getFieldError().getDefaultMessage() + : "参数绑定失败"; + log.warn("参数绑定异常: {}", message); + return Result.fail(ResultCode.PARAM_ERROR.getCode(), message); + } + + /** + * 约束违反异常 + */ + @ExceptionHandler(ConstraintViolationException.class) + @ResponseStatus(HttpStatus.BAD_REQUEST) + public Result handleConstraintViolationException(ConstraintViolationException e) { + log.warn("约束违反异常: {}", e.getMessage()); + return Result.fail(ResultCode.PARAM_ERROR.getCode(), e.getMessage()); + } + + /** + * 其他异常 + */ + @ExceptionHandler(Exception.class) + @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) + public Result handleException(Exception e) { + log.error("系统异常: ", e); + return Result.fail(ResultCode.INTERNAL_ERROR); + } +} diff --git a/src/main/java/com/dora/common/result/Result.java b/src/main/java/com/dora/common/result/Result.java new file mode 100644 index 0000000..177b7a2 --- /dev/null +++ b/src/main/java/com/dora/common/result/Result.java @@ -0,0 +1,59 @@ +package com.dora.common.result; + +import lombok.Data; + +import java.io.Serializable; + +/** + * 统一响应结果 + * + * @param 数据类型 + * @author dora + */ +@Data +public class Result implements Serializable { + + private static final long serialVersionUID = 1L; + + private Integer code; + private String message; + private T data; + private Long timestamp; + + public Result() { + this.timestamp = System.currentTimeMillis(); + } + + public static Result success() { + return success(null); + } + + public static Result success(T data) { + Result result = new Result<>(); + result.setCode(ResultCode.SUCCESS.getCode()); + result.setMessage(ResultCode.SUCCESS.getMessage()); + result.setData(data); + return result; + } + + public static Result fail(String message) { + Result result = new Result<>(); + result.setCode(ResultCode.FAIL.getCode()); + result.setMessage(message); + return result; + } + + public static Result fail(ResultCode resultCode) { + Result result = new Result<>(); + result.setCode(resultCode.getCode()); + result.setMessage(resultCode.getMessage()); + return result; + } + + public static Result fail(Integer code, String message) { + Result result = new Result<>(); + result.setCode(code); + result.setMessage(message); + return result; + } +} diff --git a/src/main/java/com/dora/common/result/ResultCode.java b/src/main/java/com/dora/common/result/ResultCode.java new file mode 100644 index 0000000..9c6fcfe --- /dev/null +++ b/src/main/java/com/dora/common/result/ResultCode.java @@ -0,0 +1,81 @@ +package com.dora.common.result; + +import lombok.Getter; + +/** + * 响应状态码枚举 + * + * @author dora + */ +@Getter +public enum ResultCode { + + // ========== 成功 ========== + SUCCESS(0, "操作成功"), + + // ========== 通用失败 ========== + FAIL(1, "操作失败"), + + // ========== 客户端错误 1xxx ========== + PARAM_ERROR(1001, "参数错误"), + PARAM_MISSING(1002, "参数缺失"), + PARAM_TYPE_ERROR(1003, "参数类型错误"), + PARAM_VALID_ERROR(1004, "参数校验失败"), + + // ========== 认证授权 2xxx ========== + UNAUTHORIZED(2001, "未登录或登录已过期"), + TOKEN_INVALID(2002, "Token无效"), + TOKEN_EXPIRED(2003, "Token已过期"), + FORBIDDEN(2004, "无权限访问"), + ACCOUNT_DISABLED(2005, "账号已被禁用"), + ACCOUNT_LOCKED(2006, "账号已被锁定"), + LOGIN_FAILED(2007, "用户名或密码错误"), + + // ========== 用户相关 3xxx ========== + USER_NOT_FOUND(3001, "用户不存在"), + USER_ALREADY_EXISTS(3002, "用户已存在"), + USER_PASSWORD_ERROR(3003, "密码错误"), + USER_PHONE_EXISTS(3004, "手机号已被注册"), + USER_EMAIL_EXISTS(3005, "邮箱已被注册"), + + // ========== 业务错误 4xxx ========== + DATA_NOT_FOUND(4001, "数据不存在"), + DATA_ALREADY_EXISTS(4002, "数据已存在"), + DATA_SAVE_FAILED(4003, "数据保存失败"), + DATA_UPDATE_FAILED(4004, "数据更新失败"), + DATA_DELETE_FAILED(4005, "数据删除失败"), + OPERATION_FAILED(4006, "操作失败"), + OPERATION_NOT_ALLOWED(4007, "操作不允许"), + OPERATION_TOO_FREQUENT(4008, "操作过于频繁，请稍后再试"), + VERIFICATION_CODE_ERROR(4009, "验证码错误或已过期"), + EMAIL_SEND_FAILED(4010, "邮件发送失败"), + + // ========== 微信相关 5xxx ========== + WECHAT_AUTH_FAILED(5001, "微信授权失败"), + WECHAT_CODE_INVALID(5002, "微信code无效"), + WECHAT_USER_NOT_BOUND(5003, "微信用户未绑定"), + WECHAT_API_ERROR(5004, "微信接口调用失败"), + + // ========== 文件相关 6xxx ========== + FILE_NOT_FOUND(6001, "文件不存在"), + FILE_UPLOAD_FAILED(6002, "文件上传失败"), + FILE_TYPE_NOT_ALLOWED(6003, "文件类型不允许"), + FILE_SIZE_EXCEEDED(6004, "文件大小超出限制"), + + // ========== 系统错误 9xxx ========== + INTERNAL_ERROR(9000, "系统内部错误"), + SYSTEM_ERROR(9001, "系统错误"), + SERVICE_UNAVAILABLE(9002, "服务不可用"), + NETWORK_ERROR(9003, "网络异常"), + DATABASE_ERROR(9004, "数据库异常"), + THIRD_PARTY_ERROR(9005, "第三方服务异常"), + RATE_LIMIT_EXCEEDED(9006, "请求过于频繁"); + + private final Integer code; + private final String message; + + ResultCode(Integer code, String message) { + this.code = code; + this.message = message; + } +} diff --git a/src/main/java/com/dora/config/CosConfig.java b/src/main/java/com/dora/config/CosConfig.java new file mode 100644 index 0000000..5aaad80 --- /dev/null +++ b/src/main/java/com/dora/config/CosConfig.java @@ -0,0 +1,47 @@ +package com.dora.config; + +import com.qcloud.cos.COSClient; +import com.qcloud.cos.ClientConfig; +import com.qcloud.cos.auth.BasicCOSCredentials; +import com.qcloud.cos.auth.COSCredentials; +import com.qcloud.cos.region.Region; +import lombok.Data; +import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +/** + * 腾讯云 COS 配置 + * + * @author dora + */ +@Data +@Configuration +@ConfigurationProperties(prefix = "tencent.cos") +public class CosConfig { + + private String secretId; + private String secretKey; + private String region; + private String bucketName; + private String userImgFolder; + private Integer expirationSeconds; + private String customDomain; + + @Bean + public COSClient cosClient() { + COSCredentials credentials = new BasicCOSCredentials(secretId, secretKey); + ClientConfig clientConfig = new ClientConfig(new Region(region)); + return new COSClient(credentials, clientConfig); + } + + /** + * 获取文件访问URL + */ + public String getFileUrl(String key) { + if (customDomain != null && !customDomain.isEmpty()) { + return customDomain + "/" + key; + } + return String.format("https://%s.cos.%s.myqcloud.com/%s", bucketName, region, key); + } +} diff --git a/src/main/java/com/dora/config/DatabaseInitConfig.java b/src/main/java/com/dora/config/DatabaseInitConfig.java new file mode 100644 index 0000000..135754e --- /dev/null +++ b/src/main/java/com/dora/config/DatabaseInitConfig.java @@ -0,0 +1,63 @@ +package com.dora.config; + +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.CommandLineRunner; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.core.io.ClassPathResource; +import org.springframework.jdbc.datasource.init.ResourceDatabasePopulator; + +import javax.sql.DataSource; + +/** + * 数据库初始化配置 + * 每次启动时执行 schema.sql 和 data.sql + */ +@Slf4j +@Configuration +public class DatabaseInitConfig { + + @Value("${spring.sql.init.mode:never}") + private String initMode; + + @Bean + public CommandLineRunner databaseInitializer(DataSource dataSource) { + return args -> { + if (!"always".equalsIgnoreCase(initMode)) { + log.info("数据库初始化已禁用 (mode={})", initMode); + return; + } + + log.info("========== 开始初始化数据库 =========="); + + try { + ResourceDatabasePopulator populator = new ResourceDatabasePopulator(); + populator.setSqlScriptEncoding("UTF-8"); + populator.setSeparator(";"); + populator.setContinueOnError(false); + + // 执行 schema.sql（删除并重建表） + ClassPathResource schemaResource = new ClassPathResource("db/schema.sql"); + if (schemaResource.exists()) { + log.info("执行 schema.sql ..."); + populator.addScript(schemaResource); + } + + // 执行 data.sql（插入初始数据） + ClassPathResource dataResource = new ClassPathResource("db/data.sql"); + if (dataResource.exists()) { + log.info("执行 data.sql ..."); + populator.addScript(dataResource); + } + + populator.execute(dataSource); + + log.info("========== 数据库初始化完成 =========="); + } catch (Exception e) { + log.error("数据库初始化失败: {}", e.getMessage(), e); + throw new RuntimeException("数据库初始化失败", e); + } + }; + } +} diff --git a/src/main/java/com/dora/config/MyBatisPlusConfig.java b/src/main/java/com/dora/config/MyBatisPlusConfig.java new file mode 100644 index 0000000..a67df3e --- /dev/null +++ b/src/main/java/com/dora/config/MyBatisPlusConfig.java @@ -0,0 +1,28 @@ +package com.dora.config; + +import com.baomidou.mybatisplus.annotation.DbType; +import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor; +import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor; +import org.mybatis.spring.annotation.MapperScan; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +/** + * MyBatis Plus 配置 + * + * @author dora + */ +@Configuration +@MapperScan("com.dora.mapper") +public class MyBatisPlusConfig { + + /** + * 分页插件 + */ + @Bean + public MybatisPlusInterceptor mybatisPlusInterceptor() { + MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); + interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); + return interceptor; + } +} diff --git a/src/main/java/com/dora/config/RedisConfig.java b/src/main/java/com/dora/config/RedisConfig.java new file mode 100644 index 0000000..dba8f78 --- /dev/null +++ b/src/main/java/com/dora/config/RedisConfig.java @@ -0,0 +1,46 @@ +package com.dora.config; + +import com.fasterxml.jackson.annotation.JsonAutoDetect; +import com.fasterxml.jackson.annotation.PropertyAccessor; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.jsontype.impl.LaissezFaireSubTypeValidator; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.data.redis.connection.RedisConnectionFactory; +import org.springframework.data.redis.core.RedisTemplate; +import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer; +import org.springframework.data.redis.serializer.StringRedisSerializer; + +/** + * Redis 配置 + * + * @author dora + */ +@Configuration +public class RedisConfig { + + @Bean + public RedisTemplate redisTemplate(RedisConnectionFactory factory) { + RedisTemplate template = new RedisTemplate<>(); + template.setConnectionFactory(factory); + + // JSON 序列化配置 + ObjectMapper mapper = new ObjectMapper(); + mapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); + mapper.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL); + + Jackson2JsonRedisSerializer

1818AIGC API 文档

1818AI 管理系统