# rssc-code-template

**Repository Path**: only-care/rssc-code-template

## Basic Information

- **Project Name**: rssc-code-template
- **Description**: 模板生成器，基于Freemark的定制化模板，一次定制N次使用
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-06-07
- **Last Updated**: 2024-06-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# rssc-code-template

#### 介绍
模板生成器

#### 软件架构
Springboot: 模板生成器框
Jsqlparser: 基于数据表定义解析数据模型
Freemark: 用于模板定制

#### 使用说明
1. 定制模板，在项目根目录下templates中，建立模板目录，目录名称为模板名
2. 全局配置，在项目根目录下templates中创建名为global.properties的配置文件用于定制全局动态参数
3. 模板配置，在模板目录下创建名为init.properties的配置文件用于定制模板动态参数(在实际使用中推荐使用[project].properties做配置，通过动态参数project告诉服务使用哪个项目配置文件)
4. 数据模型，支持直连数据库或在模板目录下创建sql文件（sql为建表语句，支持多sql文件，也支持单sql文件支持多条语句，文件后缀为.sql，不要有注释行）
5. 执行模板生成器，将模板名作为参数传递给程序，告诉你需要使用的模板。示例：java -jar -Dtmpl=demo rssc-code-template-1.0-SNAPSHOT.jar
6. 获取生成的文件，默认为项目根目录下output目录中模板编码目录下。示例：/output/demo

* 以上templates目录可通过参数templates定制
* 以上output目录可通过参数output定制

Release（发行版）
1. 解压项目
2. 使用notepad++将bat文件转window(crlf)格式
3. 执行compile.bat编译项目（确保本地正确配置Maven、JDK环境）
4. 执行start.bat运行模板生成器

#### 使用问题
1. 常见异常为模板渲染异常，可基于异常日志，检查动态参数和模板定义。
2. 批处理文件执行异常，尝试将bat文件转window(crlf)格式，可以使用notepad++ 编辑>文档格式转换>转为Windows(CR LF)