wkc/loan-pricing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

增删改查完成

Browse Source
This commit is contained in:
wkc
2026-01-20 11:20:39 +08:00
commit b6443ba07f
651 changed files with 71574 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

456
openspec/AGENTS.md Normal file
View File

@@ -0,0 +1,456 @@
# OpenSpec Instructions
Instructions for AI coding assistants using OpenSpec for spec-driven development.
## TL;DR Quick Checklist
- Search existing work: `openspec spec list --long`, `openspec list` (use `rg` only for full-text search)
- Decide scope: new capability vs modify existing capability
- Pick a unique `change-id`: kebab-case, verb-led (`add-`, `update-`, `remove-`, `refactor-`)
- Scaffold: `proposal.md`, `tasks.md`, `design.md` (only if needed), and delta specs per affected capability
- Write deltas: use `## ADDED|MODIFIED|REMOVED|RENAMED Requirements`; include at least one `#### Scenario:` per requirement
- Validate: `openspec validate [change-id] --strict --no-interactive` and fix issues
- Request approval: Do not start implementation until proposal is approved
## Three-Stage Workflow
### Stage 1: Creating Changes
Create proposal when you need to:
- Add features or functionality
- Make breaking changes (API, schema)
- Change architecture or patterns
- Optimize performance (changes behavior)
- Update security patterns
Triggers (examples):
- "Help me create a change proposal"
- "Help me plan a change"
- "Help me create a proposal"
- "I want to create a spec proposal"
- "I want to create a spec"
Loose matching guidance:
- Contains one of: `proposal`, `change`, `spec`
- With one of: `create`, `plan`, `make`, `start`, `help`
Skip proposal for:
- Bug fixes (restore intended behavior)
- Typos, formatting, comments
- Dependency updates (non-breaking)
- Configuration changes
- Tests for existing behavior
**Workflow**
1. Review `openspec/project.md`, `openspec list`, and `openspec list --specs` to understand current context.
2. Choose a unique verb-led `change-id` and scaffold `proposal.md`, `tasks.md`, optional `design.md`, and spec deltas under `openspec/changes/<id>/`.
3. Draft spec deltas using `## ADDED|MODIFIED|REMOVED Requirements` with at least one `#### Scenario:` per requirement.
4. Run `openspec validate <id> --strict --no-interactive` and resolve any issues before sharing the proposal.
### Stage 2: Implementing Changes
Track these steps as TODOs and complete them one by one.
1. **Read proposal.md** - Understand what's being built
2. **Read design.md** (if exists) - Review technical decisions
3. **Read tasks.md** - Get implementation checklist
4. **Implement tasks sequentially** - Complete in order
5. **Confirm completion** - Ensure every item in `tasks.md` is finished before updating statuses
6. **Update checklist** - After all work is done, set every task to `- [x]` so the list reflects reality
7. **Approval gate** - Do not start implementation until the proposal is reviewed and approved
### Stage 3: Archiving Changes
After deployment, create separate PR to:
- Move `changes/[name]/` → `changes/archive/YYYY-MM-DD-[name]/`
- Update `specs/` if capabilities changed
- Use `openspec archive <change-id> --skip-specs --yes` for tooling-only changes (always pass the change ID explicitly)
- Run `openspec validate --strict --no-interactive` to confirm the archived change passes checks
## Before Any Task
**Context Checklist:**
- [ ] Read relevant specs in `specs/[capability]/spec.md`
- [ ] Check pending changes in `changes/` for conflicts
- [ ] Read `openspec/project.md` for conventions
- [ ] Run `openspec list` to see active changes
- [ ] Run `openspec list --specs` to see existing capabilities
**Before Creating Specs:**
- Always check if capability already exists
- Prefer modifying existing specs over creating duplicates
- Use `openspec show [spec]` to review current state
- If request is ambiguous, ask 1–2 clarifying questions before scaffolding
### Search Guidance
- Enumerate specs: `openspec spec list --long` (or `--json` for scripts)
- Enumerate changes: `openspec list` (or `openspec change list --json` - deprecated but available)
- Show details:
- Spec: `openspec show <spec-id> --type spec` (use `--json` for filters)
- Change: `openspec show <change-id> --json --deltas-only`
- Full-text search (use ripgrep): `rg -n "Requirement:|Scenario:" openspec/specs`
## Quick Start
### CLI Commands
```bash
# Essential commands
openspec list # List active changes
openspec list --specs # List specifications
openspec show [item] # Display change or spec
openspec validate [item] # Validate changes or specs
openspec archive <change-id> [--yes|-y] # Archive after deployment (add --yes for non-interactive runs)
# Project management
openspec init [path] # Initialize OpenSpec
openspec update [path] # Update instruction files
# Interactive mode
openspec show # Prompts for selection
openspec validate # Bulk validation mode
# Debugging
openspec show [change] --json --deltas-only
openspec validate [change] --strict --no-interactive
```
### Command Flags
- `--json` - Machine-readable output
- `--type change|spec` - Disambiguate items
- `--strict` - Comprehensive validation
- `--no-interactive` - Disable prompts
- `--skip-specs` - Archive without spec updates
- `--yes`/`-y` - Skip confirmation prompts (non-interactive archive)
## Directory Structure
```
openspec/
├── project.md # Project conventions
├── specs/ # Current truth - what IS built
│ └── [capability]/ # Single focused capability
│ ├── spec.md # Requirements and scenarios
│ └── design.md # Technical patterns
├── changes/ # Proposals - what SHOULD change
│ ├── [change-name]/
│ │ ├── proposal.md # Why, what, impact
│ │ ├── tasks.md # Implementation checklist
│ │ ├── design.md # Technical decisions (optional; see criteria)
│ │ └── specs/ # Delta changes
│ │ └── [capability]/
│ │ └── spec.md # ADDED/MODIFIED/REMOVED
│ └── archive/ # Completed changes
```
## Creating Change Proposals
### Decision Tree
```
New request?
├─ Bug fix restoring spec behavior? → Fix directly
├─ Typo/format/comment? → Fix directly
├─ New feature/capability? → Create proposal
├─ Breaking change? → Create proposal
├─ Architecture change? → Create proposal
└─ Unclear? → Create proposal (safer)
```
### Proposal Structure
1. **Create directory:** `changes/[change-id]/` (kebab-case, verb-led, unique)
2. **Write proposal.md:**
```markdown
# Change: [Brief description of change]
## Why
[1-2 sentences on problem/opportunity]
## What Changes
- [Bullet list of changes]
- [Mark breaking changes with **BREAKING**]
## Impact
- Affected specs: [list capabilities]
- Affected code: [key files/systems]
```
3. **Create spec deltas:** `specs/[capability]/spec.md`
```markdown
## ADDED Requirements
### Requirement: New Feature
The system SHALL provide...
#### Scenario: Success case
- **WHEN** user performs action
- **THEN** expected result
## MODIFIED Requirements
### Requirement: Existing Feature
[Complete modified requirement]
## REMOVED Requirements
### Requirement: Old Feature
**Reason**: [Why removing]
**Migration**: [How to handle]
```
If multiple capabilities are affected, create multiple delta files under `changes/[change-id]/specs/<capability>/spec.md`—one per capability.
4. **Create tasks.md:**
```markdown
## 1. Implementation
- [ ] 1.1 Create database schema
- [ ] 1.2 Implement API endpoint
- [ ] 1.3 Add frontend component
- [ ] 1.4 Write tests
```
5. **Create design.md when needed:**
Create `design.md` if any of the following apply; otherwise omit it:
- Cross-cutting change (multiple services/modules) or a new architectural pattern
- New external dependency or significant data model changes
- Security, performance, or migration complexity
- Ambiguity that benefits from technical decisions before coding
Minimal `design.md` skeleton:
```markdown
## Context
[Background, constraints, stakeholders]
## Goals / Non-Goals
- Goals: [...]
- Non-Goals: [...]
## Decisions
- Decision: [What and why]
- Alternatives considered: [Options + rationale]
## Risks / Trade-offs
- [Risk] → Mitigation
## Migration Plan
[Steps, rollback]
## Open Questions
- [...]
```
## Spec File Format
### Critical: Scenario Formatting
**CORRECT** (use #### headers):
```markdown
#### Scenario: User login success
- **WHEN** valid credentials provided
- **THEN** return JWT token
```
**WRONG** (don't use bullets or bold):
```markdown
- **Scenario: User login** ❌
**Scenario**: User login ❌
### Scenario: User login ❌
```
Every requirement MUST have at least one scenario.
### Requirement Wording
- Use SHALL/MUST for normative requirements (avoid should/may unless intentionally non-normative)
### Delta Operations
- `## ADDED Requirements` - New capabilities
- `## MODIFIED Requirements` - Changed behavior
- `## REMOVED Requirements` - Deprecated features
- `## RENAMED Requirements` - Name changes
Headers matched with `trim(header)` - whitespace ignored.
#### When to use ADDED vs MODIFIED
- ADDED: Introduces a new capability or sub-capability that can stand alone as a requirement. Prefer ADDED when the change is orthogonal (e.g., adding "Slash Command Configuration") rather than altering the semantics of an existing requirement.
- MODIFIED: Changes the behavior, scope, or acceptance criteria of an existing requirement. Always paste the full, updated requirement content (header + all scenarios). The archiver will replace the entire requirement with what you provide here; partial deltas will drop previous details.
- RENAMED: Use when only the name changes. If you also change behavior, use RENAMED (name) plus MODIFIED (content) referencing the new name.
Common pitfall: Using MODIFIED to add a new concern without including the previous text. This causes loss of detail at archive time. If you aren’t explicitly changing the existing requirement, add a new requirement under ADDED instead.
Authoring a MODIFIED requirement correctly:
1) Locate the existing requirement in `openspec/specs/<capability>/spec.md`.
2) Copy the entire requirement block (from `### Requirement: ...` through its scenarios).
3) Paste it under `## MODIFIED Requirements` and edit to reflect the new behavior.
4) Ensure the header text matches exactly (whitespace-insensitive) and keep at least one `#### Scenario:`.
Example for RENAMED:
```markdown
## RENAMED Requirements
- FROM: `### Requirement: Login`
- TO: `### Requirement: User Authentication`
```
## Troubleshooting
### Common Errors
**"Change must have at least one delta"**
- Check `changes/[name]/specs/` exists with .md files
- Verify files have operation prefixes (## ADDED Requirements)
**"Requirement must have at least one scenario"**
- Check scenarios use `#### Scenario:` format (4 hashtags)
- Don't use bullet points or bold for scenario headers
**Silent scenario parsing failures**
- Exact format required: `#### Scenario: Name`
- Debug with: `openspec show [change] --json --deltas-only`
### Validation Tips
```bash
# Always use strict mode for comprehensive checks
openspec validate [change] --strict --no-interactive
# Debug delta parsing
openspec show [change] --json | jq '.deltas'
# Check specific requirement
openspec show [spec] --json -r 1
```
## Happy Path Script
```bash
# 1) Explore current state
openspec spec list --long
openspec list
# Optional full-text search:
# rg -n "Requirement:|Scenario:" openspec/specs
# rg -n "^#|Requirement:" openspec/changes
# 2) Choose change id and scaffold
CHANGE=add-two-factor-auth
mkdir -p openspec/changes/$CHANGE/{specs/auth}
printf "## Why\n...\n\n## What Changes\n- ...\n\n## Impact\n- ...\n" > openspec/changes/$CHANGE/proposal.md
printf "## 1. Implementation\n- [ ] 1.1 ...\n" > openspec/changes/$CHANGE/tasks.md
# 3) Add deltas (example)
cat > openspec/changes/$CHANGE/specs/auth/spec.md << 'EOF'
## ADDED Requirements
### Requirement: Two-Factor Authentication
Users MUST provide a second factor during login.
#### Scenario: OTP required
- **WHEN** valid credentials are provided
- **THEN** an OTP challenge is required
EOF
# 4) Validate
openspec validate $CHANGE --strict --no-interactive
```
## Multi-Capability Example
```
openspec/changes/add-2fa-notify/
├── proposal.md
├── tasks.md
└── specs/
├── auth/
│ └── spec.md # ADDED: Two-Factor Authentication
└── notifications/
└── spec.md # ADDED: OTP email notification
```
auth/spec.md
```markdown
## ADDED Requirements
### Requirement: Two-Factor Authentication
...
```
notifications/spec.md
```markdown
## ADDED Requirements
### Requirement: OTP Email Notification
...
```
## Best Practices
### Simplicity First
- Default to <100 lines of new code
- Single-file implementations until proven insufficient
- Avoid frameworks without clear justification
- Choose boring, proven patterns
### Complexity Triggers
Only add complexity with:
- Performance data showing current solution too slow
- Concrete scale requirements (>1000 users, >100MB data)
- Multiple proven use cases requiring abstraction
### Clear References
- Use `file.ts:42` format for code locations
- Reference specs as `specs/auth/spec.md`
- Link related changes and PRs
### Capability Naming
- Use verb-noun: `user-auth`, `payment-capture`
- Single purpose per capability
- 10-minute understandability rule
- Split if description needs "AND"
### Change ID Naming
- Use kebab-case, short and descriptive: `add-two-factor-auth`
- Prefer verb-led prefixes: `add-`, `update-`, `remove-`, `refactor-`
- Ensure uniqueness; if taken, append `-2`, `-3`, etc.
## Tool Selection Guide
| Task | Tool | Why |
|------|------|-----|
| Find files by pattern | Glob | Fast pattern matching |
| Search code content | Grep | Optimized regex search |
| Read specific files | Read | Direct file access |
| Explore unknown scope | Task | Multi-step investigation |
## Error Recovery
### Change Conflicts
1. Run `openspec list` to see active changes
2. Check for overlapping specs
3. Coordinate with change owners
4. Consider combining proposals
### Validation Failures
1. Run with `--strict` flag
2. Check JSON output for details
3. Verify spec file format
4. Ensure scenarios properly formatted
### Missing Context
1. Read project.md first
2. Check related specs
3. Review recent archives
4. Ask for clarification
## Quick Reference
### Stage Indicators
- `changes/` - Proposed, not yet built
- `specs/` - Built and deployed
- `archive/` - Completed changes
### File Purposes
- `proposal.md` - Why and what
- `tasks.md` - Implementation steps
- `design.md` - Technical decisions
- `spec.md` - Requirements and behavior
### CLI Essentials
```bash
openspec list # What's in progress?
openspec show [item] # View details
openspec validate --strict --no-interactive # Is it correct?
openspec archive <change-id> [--yes|-y] # Mark complete (add --yes for automation)
```
Remember: Specs are truth. Changes are proposals. Keep them in sync.

24
openspec/changes/add-loan-pricing-workflow/proposal.md Normal file
View File

@@ -0,0 +1,24 @@
# Change: 添加利率定价流程管理功能
## Why
当前系统缺少利率定价流程的管理能力。业务人员需要能够发起利率定价申请、查询历史定价记录、查看定价详情。这是贷款定价系统的核心功能需求。
## What Changes
- 创建新的 Maven 模块 `ruoyi-loan-pricing` 用于利率定价相关功能
- 新增利率定价流程的发起接口
- 新增利率定价流程的列表查询接口(支持分页和多条件筛选)
- 新增根据业务方流水号查看详情的接口
- 创建数据库表存储利率定价流程数据
- 添加对应的实体类、Mapper、Service、Controller
## Impact
- **Affected specs:** 新增 `loan-pricing-workflow` 能力规格
- **Affected code:**
- **新增 `ruoyi-loan-pricing` Maven 模块** - 包含 Domain、Mapper、Service
- 修改 `pom.xml` 添加新模块依赖
- 新增 `ruoyi-admin` 模块下的 Controller
- 新增数据库表和 MyBatis XML 映射文件
- 新增前端 API 接口定义和页面组件(待后续阶段实现)

73
openspec/changes/add-loan-pricing-workflow/specs/loan-pricing-workflow/spec.md Normal file
View File

@@ -0,0 +1,73 @@
## ADDED Requirements
### Requirement: 利率定价流程发起
系统 SHALL 提供利率定价流程发起接口,允许业务人员创建新的利率定价申请。
#### Scenario: 成功发起利率定价流程
- **WHEN** 业务人员提交包含必填字段(custIsn、custType、guarType、applyAmt、loanRate)的完整申请
- **THEN** 系统自动生成业务方流水号(serialNum)并保存记录,返回成功响应
#### Scenario: 自动生成业务方流水号
- **WHEN** 发起利率定价流程时
- **THEN** 系统使用时间戳自动生成唯一的业务方流水号,无需用户输入
#### Scenario: 记录创建和更新信息
- **WHEN** 利率定价流程创建成功
- **THEN** 系统自动记录创建者、创建时间、更新者、更新时间
#### Scenario: 字段验证-必填字段
- **WHEN** 提交的申请缺少必填字段(custIsn、custType、guarType、applyAmt、loanRate)
- **THEN** 系统返回参数验证失败的错误信息
#### Scenario: 字段验证-固定值字段
- **WHEN** 提交的申请中 orgCode 非 "931000" 或 runType 非 "1"
- **THEN** 系统返回参数验证失败的错误信息
#### Scenario: 字段验证-枚举值
- **WHEN** 提交的申请中 custType 不是"个人"或"企业"
- **THEN** 系统返回参数验证失败的错误信息
#### Scenario: 字段验证-担保方式
- **WHEN** 提交的申请中 guarType 不是"信用"、"保证"、"抵押"、"质押"之一
- **THEN** 系统返回参数验证失败的错误信息
### Requirement: 利率定价流程列表查询
系统 SHALL 提供利率定价流程列表查询接口,支持分页和多条件筛选。
#### Scenario: 默认按更新时间倒序排列
- **WHEN** 业务人员查询利率定价流程列表
- **THEN** 结果按更新时间(update_time)倒序排列
#### Scenario: 支持分页查询
- **WHEN** 业务人员指定页码和每页数量查询列表
- **THEN** 系统返回对应页的数据及总记录数
#### Scenario: 按创建者筛选
- **WHEN** 业务人员按创建者筛选查询
- **THEN** 系统返回该创建者创建的利率定价流程记录
#### Scenario: 按客户名称筛选
- **WHEN** 业务人员按客户名称(custName)模糊查询
- **THEN** 系统返回客户名称包含查询条件的记录
#### Scenario: 按机构号筛选
- **WHEN** 业务人员按机构号(orgCode)筛选查询
- **THEN** 系统返回该机构号的利率定价流程记录
#### Scenario: 组合条件筛选
- **WHEN** 业务人员同时指定多个筛选条件
- **THEN** 系统返回同时满足所有条件的记录
### Requirement: 利率定价流程详情查询
系统 SHALL 提供根据业务方流水号查询流程详情的接口。
#### Scenario: 根据业务方流水号查询详情
- **WHEN** 业务人员提供有效的业务方流水号(serialNum)
- **THEN** 系统返回该流程的所有字段信息
#### Scenario: 查询不存在的流水号
- **WHEN** 业务人员查询的业务方流水号不存在
- **THEN** 系统返回"记录不存在"的错误信息

78
openspec/changes/add-loan-pricing-workflow/tasks.md Normal file
View File

@@ -0,0 +1,78 @@
## 1. 创建新 Maven 模块
- [x] 1.1 创建 `ruoyi-loan-pricing` 模块目录结构
- [x] 1.2 创建 `ruoyi-loan-pricing/pom.xml`
- 继承父 pom
- 添加 `ruoyi-common` 依赖
- 添加 MyBatis Plus 依赖
- 添加 Spring Boot 相关依赖
- [x] 1.3 修改根 `pom.xml`
- 在 `<modules>` 中添加 `ruoyi-loan-pricing` 模块
- 在 `dependencyManagement` 中添加模块依赖管理
- [x] 1.4 修改 `ruoyi-admin/pom.xml`
- 添加 `ruoyi-loan-pricing` 模块依赖
## 2. 数据库设计与实现
- [x] 2.1 设计利率定价流程数据库表结构
- 包含所有必需字段(24个字段)
- 添加主键、索引
- 添加审计字段(create_by, create_time, update_by, update_time)
- [x] 2.2 创建数据库表 SQL 脚本
## 3. 后端实体类开发
- [x] 3.1 在 `ruoyi-loan-pricing` 模块中创建 `LoanPricingWorkflow` 实体类
- 使用 `@Data` 注解
- 使用 `@TableName` 映射数据库表名
- 所有字段添加数据库映射注解
- 手动添加审计字段(createBy, createTime, updateBy, updateTime)
- [x] 3.2 添加字段验证注解(@NotNull、@NotBlank等)
## 4. 后端 Mapper 层开发
- [x] 4.1 在 `ruoyi-loan-pricing` 模块中创建 `LoanPricingWorkflowMapper` 接口
- 继承 MyBatis Plus 的 `BaseMapper<LoanPricingWorkflow>`
- 定义自定义查询方法(如果需要)
- [x] 4.2 创建 MyBatis XML 映射文件(如果需要自定义 SQL)
## 5. 后端 Service 层开发
- [x] 5.1 在 `ruoyi-loan-pricing` 模块中创建 `ILoanPricingWorkflowService` 接口
- 定义发起流程方法 `createLoanPricing`
- 定义列表查询方法 `selectLoanPricingList`
- 定义详情查询方法 `selectLoanPricingBySerialNum`
- [x] 5.2 创建 `LoanPricingWorkflowServiceImpl` 实现类
- 实现业务逻辑
- 生成业务方流水号(时间戳)
- 实现分页查询
- 实现多条件筛选
## 6. 后端 Controller 层开发
- [x] 6.1 在 `ruoyi-admin` 模块中创建 `LoanPricingWorkflowController` 控制器
- 添加 `@RestController` 和 `@RequestMapping` 注解
- 添加 SpringDoc/OpenAPI 注解用于生成 API 文档
- 实现发起接口 `POST /loanPricing/workflow/create`
- 实现列表查询接口 `GET /loanPricing/workflow/list`
- 实现详情查询接口 `GET /loanPricing/workflow/{serialNum}`
- [x] 6.2 添加操作日志注解 `@Log`
- [x] 6.3 添加 SpringDoc 注解生成 API 文档
- 使用 `@Tag` 定义控制器标签
- 使用 `@Operation` 定义接口描述
- 使用 `@Parameter` 定义参数说明
## 7. 测试与验证
- [x] 7.1 编写单元测试(可选)
- [x] 7.2 使用 Postman 或 Swagger UI 进行接口测试
- [x] 7.3 验证所有场景(成功和失败场景)
## 8. 文档与配置
- [x] 8.1 确认 MyBatis Plus 配置正确
- [x] 8.2 确认数据库表已创建
- [x] 8.3 验证 API 文档自动生成
- 访问 `/swagger-ui.html` 确认接口文档已生成
- 验证接口描述、参数说明、响应示例完整
- [x] 8.4 创建 API 接口文档 Markdown 文件

31
openspec/project.md Normal file
View File

@@ -0,0 +1,31 @@
# Project Context
## Purpose
[Describe your project's purpose and goals]
## Tech Stack
- [List your primary technologies]
- [e.g., TypeScript, React, Node.js]
## Project Conventions
### Code Style
[Describe your code style preferences, formatting rules, and naming conventions]
### Architecture Patterns
[Document your architectural decisions and patterns]
### Testing Strategy
[Explain your testing approach and requirements]
### Git Workflow
[Describe your branching strategy and commit conventions]
## Domain Context
[Add domain-specific knowledge that AI assistants need to understand]
## Important Constraints
[List any technical, business, or regulatory constraints]
## External Dependencies
[Document key external services, APIs, or systems]