Cursor-auto-rules-agile-workflow

2025/3/29 工作流Cursor

# 一、5分钟快速上手

1. 安装规则库(给AI装开发经验包)

# 先把规则库下载到本地
http://192.168.0.200/curosr/cursor-auto-rules.git

# 应用到你的项目(比如你的项目在D:\projects\cloud-mall)
cd cursor-auto-rules
./apply-rules.sh D:\projects\cloud-mall

👉 这就相当于给项目安装了AI的"开发经验包"

2. 目录介绍 安装后,项目目录中会出现以下截图信息内容:

1536ec10-9bb5-45c5-b360-fe2f3c52beeb

1. .ai文件夹(敏捷开发必备)

  • 概要说明 再敏捷开发过程中,用于存放开发设计的相关文档比如prd.md(需求的细化总结),arch.md(技术设计文档),story-xx.md(故事点:包含故事描述,验收标准,技术要求,任务点,依赖等信息)
  • 如何使用 1,该目录主要是用来创建和管理,编码前的相关文档的输出内容以及格式。通过该文件夹下的文档管理来控制后续编码的需求参考以及实现参考,所以要保证相关文档的准确性

2

示例:我需要实现一个收货地址的功能,收货地址主要信息包含,收货人,地区,联系电话,详细地址,联系人,基于以上进行需求和相关文档的编写,先不要编码。生成效果如下: 示例-prd.md 示例-arch.md 示例-story.md

1. .cursor-rule文件夹(规则必备)

  • 概要说明 用于管理在日常开发过程中,不管的通过规则的约束,来矫正AI编码的准确度,来保证提效的目的
  • 如何使用 1,只需要对话来生成规则,通过000-rule.mdc的规则要求,创建规则文件

33

示例:基于workespace 重新整理并生成一份新的规则 规则生成标准 参考 @000-cursor-rules.mdc 。生成效果如下:

444

# 二、Java微服务开发案例

情况1:生成统一响应格式 在聊天框输入: /生成全局响应实体,要求带code/msg/data,用lombok

AI自动生成:

// 自动添加了@Builder等常用注解
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class ApiResponse<T> {
    private int code;
    private String msg;
    private T data;
  
    public static <T> ApiResponse<T> success(T data) {
        return ApiResponse.<T>builder()
                .code(200)
                .msg("success")
                .data(data)
                .build();
    }
}

原理:.mdc规则文件里预设了响应实体规范


情况2:生成Feign客户端 输入: 创建OrderService的Feign客户端,要求带降级处理

AI生成:

@FeignClient(name = "order-service", fallback = OrderFallback.class)
public interface OrderFeign {
  
    @GetMapping("/orders/{id}")
    ApiResponse<OrderVO> getOrder(@PathVariable Long id);
}

// 自动生成配套的降级类
@Component
public class OrderFallback implements OrderFeign {
    @Override
    public ApiResponse<OrderVO> getOrder(Long id) {
        return ApiResponse.error(500, "服务不可用");
    }
}

👉 因为规则里配置了FeignClient的模板


# 三、Vue前端开发案例

情况1:生成Axios请求 在Vue组件里输入:写获取用户列表的请求

AI生成:

// 自动使用配置好的axios实例
import http from '@/utils/request'

const fetchUsers = async () => {
  try {
    const { data } = await http.get('/api/users')
    return data
  } catch (e) {
    ElMessage.error('加载失败')
    return []
  }
}

秘密:规则文件中锁定了axios实例的使用


# ✨ 项目总结及注意事项 ✨

mdc规则生成失败解决方案:

IDE 设置强烈建议:为了获得规则生成的最佳结果,请通过添加以下内容更新光标设置,即在cursor的setting.json文件中增加以下配置:

"workbench.editorAssociations": {
  "*.mdc": "default"
}

三大核心价值:

  1. 新人秒变高手:刚来的实习生用这套规则写出来的代码也符合规范
  2. 错误率降70%:统一异常处理+参数校验规范把低级bug都过滤了
  3. 开发速度翻倍:原来3天的接口现在1天就搞完

最适合这些场景: ✔️ 老项目改造统一代码风格 ✔️ 频繁迭代的微服务系统