# coderule

**Repository Path**: xcmin/coderule

## Basic Information

- **Project Name**: coderule
- **Description**: 通用单据编码规则stater
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2024-08-31
- **Last Updated**: 2024-08-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CodeRule

#### 介绍
通用编码规则starter ：配置编码规则，生成业务编码

#### 软件架构
1.  springboot（web模块）
2.  mybatisplus


#### 安装教程
1.  如普通springboot项目般，引入springboot的web模块、mysql驱动、数据库连接池等依赖，配置数据库连接信息等
2.  项目强依赖mybatisplus，需引入mybatis-plus-boot-starter
3.  引入本项目starter
4.  执行sql脚本，数据库创建编码规则配置表
- maven坐标
    ```xml
        <dependency>
            <groupId>com.young</groupId>
            <artifactId>coderule-spring-boot-starter</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>
    ```
    

#### 使用说明

1.  如安装教程，配置好依赖
2.  配置编码规则
3.  调用接口生成编码
#### 接口说明
1. 编码规则配置接口
- url：:项目域名/
- 请求方式：post
- 参数说明：
```properties
            datas:
            
```
- 请求参数json：
```json
            {

            }
  ```
2.  获取编码接口
- 注意: 导入的excel模板最好不要随意更改，特别是字段标识行需要与后台实体能够对应上
- url：项目域名/
- 请求方式：post
- 参数说明：
```properties
            
```
- 请求参数form-data：
```properties

```

#### 设计思路
1.  设计自定义注解@CodeRule，用于标注在controller层的添加数据方法上
2.  利用BeanPostProcesser接口解析@CodeRule注解，存到缓存中，在配置编码规则页面时可以用来选择
3.  前端页面新增实体时，调用获取编码接口，并将最大号数据存到缓存中
4.  利用AOP拦截@CodeRule标注的接口，处理编码规则最大号（自增，存入缓存和数据库）

#### 参与贡献

1.  Young