docs(readme): 重写项目文档,更新技术栈与功能说明
feat(character): 新增人设详情接口并优化获取逻辑
This commit is contained in:
141
README.md
141
README.md
@@ -1,26 +1,123 @@
|
||||
# SpringBoot 项目初始模板
|
||||
# Keyborad Backend
|
||||
|
||||
> Java SpringBoot 项目初始模板,整合了常用框架和示例代码,大家可以在此基础上快速开发自己的项目。
|
||||
基于 Spring Boot 3.5.5 的后端服务,集成了 AI 能力、向量搜索、Apple 登录等功能。
|
||||
|
||||
## 模板功能
|
||||
## 技术栈
|
||||
|
||||
- Spring Boot 2.7.0(贼新)
|
||||
- Spring MVC
|
||||
- MySQL 驱动
|
||||
- MyBatis
|
||||
- MyBatis Plus
|
||||
- Spring Session Redis 分布式登录
|
||||
- Spring AOP
|
||||
- Apache Commons Lang3 工具类
|
||||
- Lombok 注解
|
||||
- Swagger + Knife4j 接口文档
|
||||
- Spring Boot 调试工具和项目处理器
|
||||
- 全局请求响应拦截器(记录日志)
|
||||
- 全局异常处理器
|
||||
- 自定义错误码
|
||||
- 封装通用响应类
|
||||
- 示例用户注册、登录、搜索功能
|
||||
- 示例单元测试类
|
||||
- 示例 SQL(用户表)
|
||||
- **Java 17** + **Spring Boot 3.5.5**
|
||||
- **Spring AI** - LLM 对话和文本嵌入(OpenAI 兼容 API)
|
||||
- **Qdrant** - 向量数据库,支持语义搜索
|
||||
- **PostgreSQL** - 关系型数据库
|
||||
- **MyBatis Plus** - ORM 框架
|
||||
- **Redis** - 会话存储和缓存
|
||||
- **Sa-Token** - 认证授权框架
|
||||
- **Knife4j** - API 文档
|
||||
- **X-File-Storage** - 文件上传(Cloudflare R2)
|
||||
- **MailerSend** - 邮件服务
|
||||
|
||||
访问 localhost:7529/api/doc.html 就能在线调试接口了,不需要前端配合啦~
|
||||
## 核心功能
|
||||
|
||||
### 认证系统
|
||||
- Apple Sign-In JWT 验证
|
||||
- Sa-Token 会话管理
|
||||
- 请求签名校验(防篡改/防重放)
|
||||
|
||||
### AI 能力
|
||||
- LLM 对话(支持流式响应)
|
||||
- 文本嵌入(1536 维向量)
|
||||
- 语义搜索(Qdrant 向量检索)
|
||||
|
||||
### 通用功能
|
||||
- 统一响应格式
|
||||
- 全局异常处理
|
||||
- 国际化支持(i18n)
|
||||
- 请求日志记录
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 环境要求
|
||||
|
||||
- JDK 17+
|
||||
- Maven 3.8+
|
||||
- PostgreSQL 14+
|
||||
- Redis 6+
|
||||
|
||||
### 本地运行
|
||||
|
||||
1. 克隆项目
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd keyborad-backend
|
||||
```
|
||||
|
||||
2. 配置数据库和 Redis
|
||||
```yaml
|
||||
# 修改 src/main/resources/application-dev.yml
|
||||
spring:
|
||||
datasource:
|
||||
url: jdbc:postgresql://localhost:5432/keyborad_db
|
||||
username: your_username
|
||||
password: your_password
|
||||
redis:
|
||||
host: localhost
|
||||
port: 6379
|
||||
```
|
||||
|
||||
3. 启动应用
|
||||
```bash
|
||||
mvn spring-boot:run
|
||||
```
|
||||
|
||||
4. 访问 API 文档
|
||||
```
|
||||
http://localhost:7529/api/doc.html
|
||||
```
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
src/main/java/com/yolo/keyborad/
|
||||
├── controller/ # REST API 端点
|
||||
├── service/ # 业务逻辑层
|
||||
│ └── impl/ # 服务实现
|
||||
├── mapper/ # MyBatis 数据库映射
|
||||
├── model/
|
||||
│ ├── entity/ # 数据库实体
|
||||
│ ├── dto/ # 请求数据传输对象
|
||||
│ └── vo/ # 响应视图对象
|
||||
├── config/ # Spring 配置类
|
||||
├── aop/ # AOP 拦截器
|
||||
├── Interceptor/ # 请求拦截器
|
||||
├── filter/ # Servlet 过滤器
|
||||
├── exception/ # 异常处理
|
||||
├── common/ # 通用工具类
|
||||
└── utils/ # 工具类
|
||||
```
|
||||
|
||||
## 配置说明
|
||||
|
||||
| 配置项 | 说明 | 默认值 |
|
||||
|-------|------|-------|
|
||||
| `server.port` | 服务端口 | 7529 |
|
||||
| `server.servlet.context-path` | 上下文路径 | /api |
|
||||
| `spring.profiles.active` | 激活配置文件 | dev |
|
||||
|
||||
## API 认证
|
||||
|
||||
### Sa-Token 认证
|
||||
需要在请求头中携带 `satoken` 字段。
|
||||
|
||||
### 请求签名
|
||||
部分接口需要签名校验,请求头需包含:
|
||||
- `X-App-Id` - 应用 ID
|
||||
- `X-Timestamp` - 时间戳
|
||||
- `X-Nonce` - 随机数
|
||||
- `X-Sign` - 签名
|
||||
|
||||
## 开发指南
|
||||
|
||||
详细的开发指南请参考 [CLAUDE.md](./CLAUDE.md)。
|
||||
|
||||
## License
|
||||
|
||||
MIT License
|
||||
|
||||
@@ -73,6 +73,7 @@ public class SaTokenConfigure implements WebMvcConfigurer {
|
||||
"/character/listByUser",
|
||||
"/user/detail",
|
||||
"/user/register",
|
||||
"/user/updateInfo",
|
||||
"/character/updateUserCharacterSort",
|
||||
"/character/delUserCharacter",
|
||||
"/user/sendVerifyMail",
|
||||
|
||||
@@ -49,8 +49,7 @@ public class CharacterController {
|
||||
@GetMapping("/detail")
|
||||
@Operation(summary = "人设详情", description = "人设详情接口")
|
||||
public BaseResponse<KeyboardCharacterRespVO> detail(@RequestParam("id") Long id) {
|
||||
KeyboardCharacter character = characterService.getById(id);
|
||||
return ResultUtils.success(BeanUtil.copyProperties(character, KeyboardCharacterRespVO.class));
|
||||
return ResultUtils.success(characterService.getDetailById(id));
|
||||
}
|
||||
|
||||
@GetMapping("/listByTag")
|
||||
|
||||
@@ -35,4 +35,6 @@ public interface KeyboardCharacterService extends IService<KeyboardCharacter>{
|
||||
List<KeyboardCharacterRespVO> selectListByTagWithNotLogin(Long tagId);
|
||||
|
||||
void addDefaultUserCharacter(Long userId);
|
||||
|
||||
KeyboardCharacterRespVO getDetailById(Long id);
|
||||
}
|
||||
|
||||
@@ -288,4 +288,22 @@ public class KeyboardCharacterServiceImpl extends ServiceImpl<KeyboardCharacterM
|
||||
this.addUserCharacter(keyboardUserCharacterAddDTO, userId);
|
||||
});
|
||||
}
|
||||
|
||||
@Override
|
||||
public KeyboardCharacterRespVO getDetailById(Long id) {
|
||||
// 根据ID获取人设信息,优先从缓存获取
|
||||
KeyboardCharacter character = this.getById(id);
|
||||
// 将实体对象转换为响应对象
|
||||
KeyboardCharacterRespVO respVO = BeanUtil.copyProperties(character, KeyboardCharacterRespVO.class);
|
||||
// 判断当前用户是否已添加该人设
|
||||
long userId = StpUtil.getLoginIdAsLong();
|
||||
// 查询用户人设关联表,判断当前用户是否已添加该人设
|
||||
KeyboardUserCharacter userCharacter = keyboardUserCharacterMapper.selectOne(
|
||||
new LambdaQueryWrapper<KeyboardUserCharacter>()
|
||||
.eq(KeyboardUserCharacter::getCharacterId, id)
|
||||
.eq(KeyboardUserCharacter::getUserId, userId));
|
||||
// 设置是否已添加的标记
|
||||
respVO.setAdded(userCharacter != null);
|
||||
return respVO;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user