# EasyDDL

**Repository Path**: cbry/easy-ddl

## Basic Information

- **Project Name**: EasyDDL
- **Description**: IDEA的Java类生成DDL的SQL文件的插件
- **Primary Language**: Kotlin
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2024-04-28
- **Last Updated**: 2024-10-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: IDEA, Kotlin, Swing, Java

## README

# EasyDDL

#### 介绍
IDEA的Java类生成DDL的SQL文件的插件

#### 软件架构
- Kotlin 项目，采用Java语言开发。
- 项目文档采用GiteePage

#### 安装教程

1. 设置项目语言全局编码格式为UTF-8；

2. 设置JDK为17，SDK为Intellij SDK包，同时设置Gradle JVM为Jdk17版本，配置Gradle使用IDEA运行（kotlin依赖较大，需要5-6G时间较长），若阿里的源不行，则切换官方源；

   <img src=".\README.assets\image-20240501150624679.png" alt="image-20240501150624679" style="zoom: 67%;" />

3. 在市场安装Plugin DevKit插件，IntelliJ IDEA从2023.3版本开始不再捆绑安装 Plugin DevKit ，需要用户自行安装该插件；

<img src=".\README.assets\image-20240501145320771.png" alt="image-20240501145320771" style="zoom:50%;" />

4. 运行，测试开发运行采用EasyDDL -> Tasks -> intellij -> runIde，会弹出新的装配了插件的IDE软件；
5. <img src=".\README.assets\image-20240501144855655.png" style="zoom:50%;" />

#### 使用说明

1. 在已编辑好的Java类中，右键菜单选择`BeanGenDDL`，即可在项目目录下生成sql文件夹以及对应的DDL的sql文件：

   <img src=".\README.assets\image-20240501150959559.png" alt="image-20240501150959559" style="zoom: 50%;" />

2. 生成文件：

<img src=".\README.assets\image-20240501151056402.png" alt="image-20240501151056402" style="zoom: 50%;" />

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request
4.  预备项目文档地址：[liaoxg/ProjectDoc (gitee.com)](https://gitee.com/cbry/project-doc)

#### 贡献要求

1. 代码简洁高效，最好写完多次优化修改，命名要求高效不拖拉繁长；
2. 特性分支提交合并请求到develop分支，经过代码走查方可合并；

#### 分支开发要求
1. 要求在特性分支开发：feature；
2. 合并于develop分支；
3. 拉取代码以develop为最新开发代码；

#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md

#### 官方资源
[IntelliJ Platform Plugin SDK](https://plugins.jetbrains.com/docs/intellij/ide-infrastructure.html)