common-springboot-template/template/TOCO.md

• 文件上传下载相关
  • 如果需求中存在文件上传下载功能，且用户未指定实现方式，则默认使用OSS。如果项目中已有相关功能，则不要重复实现。
  • 服务端需要提供接口用于提供oss的accessKeyId、policy等信息(注意接口分析时不要漏掉)
  • 前端先调用服务端接口获取accessKeyId、policy等信息，然后直接调用OSS来上传文件，随后将OSS返回的地址传给服务端做存储
  • 注意文件是由前端上传至OSS，服务端只存储url，所有服务端接口不要直接接收MultipartFile，应该直接接收文件url
  • 服务端OSS相关的基础工具代码写在项目代码的common/中。
  • oss配置默认如下，需要写在entrance/web/src/main/resources目录下的application.properties中：
    • aliyun.oss.endpoint=
    • aliyun.oss.accessKeyId=
    • aliyun.oss.aaccessKeyIdppId=
    • aliyun.oss.accessKeySecret=
    • aliyun.oss.bucketName=
    • aliyun.oss.dir=
    • aliyun.oss.policyExpire=
    • aliyun.oss.maxSize=
• 用户登录认证相关
  • 如果需求中存在用户登录认证功能，且用户未指定实现方式，则默认使用JWT。如果项目中已有相关功能，则不要重复实现。
  • 用户的Token生成和解密相关的Utils放在项目代码的common/中。
  • 在项目代码的common/中增加UserContext，用户的相关信息。
  • 后续所有用户登录校验、鉴权相关的代码可以放在用户模块entrance中的Filter中，从RequestHeader: 'Authorization': Bearer ${token}中获取用户的token然后获取用户信息放入UserContext中。
  • 登录校验需要对健康检查接口增加白名单：/api/healthcheck，登录接口。其中/api/healthcheck已经内置在系统框架引入的jar中，无需新建。
  • 注意用户的密码必须进行加密存储。
  • 注意JWT密钥长度至少要为256位。
  • 用户登录接口需要返回用户的Token字符串，无需操作response的header。
• 接口相关
  • 使用Filter完成跨域配置
  • Aspect需要放在entrance层，便于调用Service