使用说明
(一)全局设置
Paging Wrapper Setting(分页设置)
功能 :主要用于在方法写入时,为返回参数提供分页包装类。设置方式 :需准确填写分页包装类的全限定名,例如:com.. .Page 。返回参数示例 :public Page<User> testMethod() { }
View Wrapper Setting(返回前端页面参数包装设置)
功能 :主要用于方法写入环节,作为返回前端页面参数的包装类。设置方式 :设置为返回前端参数包装类的全限定名,如:com.. .CommonResponse 。返回参数示例 :public CommonResponse<Page<User>> testMethod() { }
ORM Framework(orm 框架设置)
功能 :主要用于在创建 dao.java、service.java、serviceImpl.java 文件时,依据不同的 ORM 框架(Mybaits 或 Mybatis - plus)选择对应的文件创建模板。 Remote Invocation Framework(远程调用设置)
功能 :主要应用于文件创建时的模板选择以及方法写入。Dubbo Framework :主要用于创建 provider 文件,并将方法写入 provider 文件。Openfeign :主要用于创建 Controller 文件,并将方法写入 controller 文件。
(二)业务逻辑文件创建
目录基准规则 :业务逻辑文件的目录父目录以 SpringApplication 的目录为基准。例如,若 SpringApplication 的目录为*/src/java/com/test
,则*Entity
的目录为*/src/java/com/test/entity/*Entity
。mapper.xml 文件创建路径 :在 resources 目录下进行创建,默认文件目录为 mapper 。例如:src/resources/mapper/*/EntityMapper.xml
。数据库源表结构方式创建文件 :通过数据库源表结构,可创建 entity.java、mapper.xml、dao.java、service.java、serviceImpl.java、controller.java 或者 provider.java(dubbo)文件。【数据库源表结构方式创建文件】使用步骤 :
点击 idea 边导航栏的 database 。 选择目标表结构,比如 activity 表。 右键点击并选择【Database To Business Logic】按钮即可完成创建。 实体类创建业务逻辑文件范围 :使用实体类创建业务逻辑文件时,涵盖范围包括 mapper.xml、dao.java、service.java、serviceImpl.java、controller.java 或者 provider.java(dubbo)文件。【实体类创建业务逻辑文件】使用步骤 :
方式一 :
在项目左侧目录中定位。 选择要创建业务逻辑文件的实体类。 右键点击并选择【Entity To Business Logic】按钮。 方式二 :
在要创建业务逻辑文件的实体类代码内部操作。 右键点击并选择【Entity To Business Logic】按钮。
(三)业务逻辑方法
方法写入文件范围 :方法可写入 mapper.xml、dao.java、service.java、serviceImpl.java、controller.java 或者 provider.java(dubbo)文件。写入规则 :方法在 dao.java、service.java、serviceImpl.java 中会自动写入;在 controller 或者 provider(dubbo)文件中,根据【Remote Invocation Framework】的设置来决定写入 controller 还是 provider;mapper.xml 的写入则取决于是否选择了 xml 方法。分页与返回页面参数包装 :方法的分页设置依赖 Paging Wrapper Setting(分页设置),返回页面参数包装依赖 View Wrapper Setting(返回前端参数包装设置)。文件关联写入功能 :支持以 dao.java、service.java、serviceImpl.java、controller.java 或者 provider.java(dubbo)文件为起始点,同时向其他相关文件写入方法。例如,当在 mapper.java 文件中写入方法时,会同时自动在 mapper.xml、service.java、serviceImpl.java、controller.java 或者 provider.java(dubbo)文件中完成相应写入。使用步骤 :在 mapper.xml、dao.java、service.java、serviceImpl.java、controller.java 或者 provider.java(dubbo)文件中,右键点击【Method To Business Logic】,然后根据需求选择相应参数即可完成方法写入。
(四)SQL 辅助功能
功能概述 :SQL 辅助功能主要用于为实体类新增字段生成 ALTER 语句,以及为新增实体类生成表结构 CREATE TABLE 语句。数据类型对应说明 :由于 Java 数据类型和 MySQL 数据类型并非完全一一对应,仅能实现基本的大致对应。例如,在 Java 中使用 Integer 表示状态 (1\2\3) ,生成 MySQL 的 SQL 语句时会使用 int 类型接收,而无法直接使用 MySQL 中的 tinyint 。若需要更改数据类型,需手动进行修改。【生成表结构字段 ALTER 语句】使用步骤 :
选中需要生成 ALTER 语句的字段。 右键点击并选择【Class Member To SQL】按钮即可生成。 【生成表结构 CREATE TABLE 语句】使用步骤 :
方式一 :
在项目左侧目录中操作。 选择要创建业务逻辑文件的实体类。 右键点击并选择【Class To SQL】按钮。 方式二 :
在要创建业务逻辑文件的实体类代码内部进行选择。 右键点击并选择【Class To SQL】按钮。
三、联系方式
github issue :GitHub - little-kelp/code-toolkit邮箱 :sunflower.on.sun@gmail.comQQ 群 :1030094275