2025-09-11 start:
分享一个 Cursor 项目规则(适用于前端开发 Vue 3 项目) | 蓝星空
end
rust相关规则:
---
alwaysApply: true
---
```
mysql链接:
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: 123456
url: jdbc:mysql://192.168.3.10:3306/cas?useUnicode=true&characterEncoding=utf8
```
```
redis链接:
host: 192.168.3.10:6379
port: 6379
database: 0
timeout: 1800000
password: 123456
```
---
rust:最新版
orm:seaorm
---
---
windows 11 操作系统
---
---
数据库脚本不要创建外键
---
---
不需要创建验证脚本
不需要创建测试脚本
不需要创建说明文档
---
---
不要使用docker以及docker-compose
---
---
所有时间相关的数据都需要东八区的北京时间
---
前端相关规则:
# 技术栈要求
- Vue版本:3.x
- 状态管理:Pinia
- UI框架:Element Plus
- 构建工具:Vite
- 包管理器:npm/yarn/pnpm
- 路由:Vue Router 4.x
# 代码风格
1. 函数必须包含 JSDoc 注释
2. 禁止使用 `var`,统一用 `const`/`let`
3. 函数命名必须添加 hj_前缀, 例如:hj_login
4. 组件名使用大驼峰命名法(PascalCase)
5. 文件名使用kebab-case命名法
6. 变量和函数名使用camelCase命名法
7. 不要使用ts,只使用js
java相关规则:
# 技术栈要求
- JDK版本:17
- Spring Boot版本:3.4.5
- Spring AI版本:1.0.0
- MyBatis版本:3.0.3
- Druid版本:1.2.23
- Lombok版本:1.18.30
- SpringDoc版本:2.5.0
- MySQL版本:8.0.29
- Knife4j版本:4.6.0
- 构建工具:Maven 3.8+ 或 Gradle 8.0+
- liteflow版本:2.13.2
- mybatis-plus: 3.5.13
- mybatis-plus-join: 1.5.4
# 代码风格
1. 所有方法必须包含完整的JavaDoc注解
2. 类名使用大驼峰命名法(PascalCase)
3. 方法名和变量名使用小驼峰命名法(camelCase)
4. 常量使用全大写加下划线(UPPER_SNAKE_CASE)
5. 包名使用小写字母,用点分隔
# JavaDoc规范
## 类级别注解
```java
/**
* 用户服务类
*
* @author haijin
* @version 1.0
* @since 2024-01-01
*/
@Service
public class UserService {
// 类实现
}
```
## 方法级别注解
```java
/**
* 根据用户ID获取用户信息
*
* @param userId 用户ID,不能为空
* @return 用户信息对象,如果用户不存在返回null
* @throws IllegalArgumentException 当userId为null或空时抛出
* @since 1.0
*/
public User getUserById(Long userId) {
// 方法实现
}
```
# 项目结构规范
```
src/main/java/xyz/haijin/en/
├── config/ # 配置类
├── controller/ # 控制器层
├── service/ # 服务层
├── repository/ # 数据访问层
├── entity/ # 实体类
├── dto/ # 数据传输对象
├── vo/ # 视图对象
├── util/ # 工具类
└── exception/ # 异常处理
```