free_generator是一款简单,配置灵活的代码生成器,主要用于 生成spring MVC + MyBatis框架用的model/dao/mapper类。 你可以任意配置各种参数来满足不同的要求,甚至可以自定义模版来实现自己想要的效果
git clone xxxxxcd free_generator
mvn clean package等打包完后:
cd target配置文件 config.properties 打包在了target目录,
cd free_generator-release
java -jar free_generator.jar文件生成在free_generator-release目录下
config.properties 是主要的配置文件:
config.properties:
------------------
### some default config,most of time you don't need to change this,however,except you really need.
##下面是一些默认的系统配置,大多时候你不需要修改,除非你知道这是作甚
#default use template,support model/dao/mapper now,remove anyone if you don't need
templates=model,dao,mapper //默认模版名,目前支持model,dao和mapper,可以任意修改,不能为空,自定义的模版名称前缀与默认一致
#use lombok or not
is_lombok=false //是否使用了lombok,默认不启用
#is hump name style
# 驼峰命名根据下划线后一位大写转换
is_hump_model_class=true //model类名是否是驼峰格式
is_hump_column=true //model下属性名是否是驼峰格式
#is there a init sql in dao and xml,do it for get all columns as a string show.
is_init_query=true //mapper中是否有一条默认查询
init_query_name=select //mapper中默认查询的名字
# ByteBuffer.allocate默认分配内存,报nio Exception的话可以尝试增大这个值
buffer_capacity=20480
--------------------
##### write
##### your
##### config
##### next
#show in comment
author=lousama //作者,会出现在注释里
# model/mapper/mapperXml/dao package path
# is wrapper class in model,example:Integer/int,default false
is_wrapper=false //model类中字段类型是否用包装器类型,如Integer/int,Long/long
# prefix of package path
package_prefix=com.lousama.generator //包名的前缀
# package_path = {package_prefix} + next value,set {package_prefix} null if you wanna define next
# 包名的后缀路径,完整的包名等于package_prefix + 后缀路径
package_model=model
package_mapper_xml=mapper
package_dao=dao
#default file suffix,don't add fileType here
# 默认的文件前缀,不需要加文件类型,如.java,.xml等
model_suffix= //model的后缀,这个一般默认空,会直接取表名
mapper_xml_suffix=Mapper //mapper.xml文件后缀
dao_suffix=Dao //dao文件后缀,有些人喜欢用Mapper
# jdbc info,support mysql and oracle now
jdbc_database=mysql //数据库类型,目前支持mysql和oracle
jdbc_url=localhost:3306/config //数据库连接url,格式为 ip:port/数据库实例
jdbc_username=root
jdbc_password=root
jdbc_table= //要生成文件的表名,为空的话会取实例下所有的表
这个项目是基于 velocity 模版来生成文件,你可以使用自己定义的模版来生成文件
传给 velocity模版的参数是List<Packages>,一个表对应一个Packages 类信息,字段如下:
private String dao; //dao的包路径 ,例如:com.lousama.generator.dao
private String model; //同上
private String mapperXml; //同上
private String daoName; //dao的类名字,eg:StudentDao
private String modelName; //同上
private String mapperXmlName; //同上
private String tableName; //数据库里的表名,已经格式化成大写
private String isInitQuery = ResourceUtil.getString("is_init_query");
private String initQuery = ResourceUtil.getString("init_query_name");
private String author = ResourceUtil.getString("author");
private String isLombok = ResourceUtil.getString("is_lombok");
private String initSql; //mapper.xml里的默认查询sql,例如:select id,name from table
private String pkCondition; //mapper.xml中可能用到的按照主键查询的条件,格式如:id1=#{id1} and id2=#{id2}
private List<Column> columnList; // 表名对应的表里的所有列信息
private Set<String> importSet; //model类里需要import的class集合Column 里是列字段的详细信息:
private String className; //列所属的类,例如:String,int,BigDecimal
private String importClass; //列要导入的类的全路径,如:java.math.BigDecimal
private String dbColName; //表中真实的字段名称,如果配置文件中is_hump_column}=false,那么跟下面的colName值一样
private String colName; //格式化后的列名
private String getMethod; //model文件中列对应的get方法
private String setMethod; //model文件中列对应的set方法
private int colSize; //表中列的长度
private int scale; //表中列的小数位长度,如果>0的话,number类型会被解析成BigDecimal
private int isPk; //该列是否是主键有了以上参数的支持,如果你懂得velocity语法的话,可能很自由的定制自己的模版来生成文件
暂时支持下面这些表字段类型:
- int/integer/smallint/tinyint
- bigint/long
- varchar/varchar2
- number/numeric/decimal/double/float
- timestamp/datetime/date
建议不要连接生产环境的数据库
如果你有更棒的建议,请提issues或者给我邮件me@lousama.com
v1.3:
- 生成的sql语句中表名默认小写
- 修改了not_in_sql_column参数不生效的bug
v1.2:
- 修正了velocity模版中有中文时写入文件乱码的bug
- Packages类中添加属性:
- insertStatements 在xml中用于新增语句,例如:insert into table(initQuery) values(insertStatements),为了保证字段顺序,initQuery已改成不包含sql关键字的字段排列
- updateStatements 在xml中用于更新的语句块,例如:update table set updateStatements where xxxx,适用于全字段更新(包括主键)
- modelNameLowerFirst model类的首字母小写,便于在dao接口层作为参数使用,例如(Student student)
v1.1:
- 添加了mapper.xml文件resultMap的主键解析
- Packages类中添加属性:
- pkCondition 用于在xml使用主键作为条件进行增删改操作,例如id1=#{id1} and id2=#{id2}
- 新增了许多注释