随着各公司团队推行敏捷,项目文档越来越少(是不是对敏捷理解过激了),很多项目没有了数据库文档,针对我们项目中使用hibernate 在对象上增加注解直接生成数据库,考虑是否可以生成数据库文档,doclet提供了hibernate的文档注解但是需要将column等在注释的注解中再写一遍和字段上的注解定义重复了,因此决定自己写一个maven插件。
生成后所有表都在一个html中:
[img]http://dl2.iteye.com/upload/attachment/0098/7831/1b1231da-0bca-3c64-ba3c-ffdfad5ef103.jpg[/img]
基本思想:
在po中将字段上的注释改为注解形式,并通过解析其他JPA注解最终形成数据库文档。
功能: 生成数据库文档
使用方法(注意:如果只是使用的话,不必从svn中检出此插件代码,插件已deploy到maven仓库中)
1.修改po中的注释形式 由图中下面的形式改为上面注解的形式。
[img]http://dl2.iteye.com/upload/attachment/0098/7833/7dacb68b-709b-3c29-b041-5dc9ea40245a.jpg[/img]
2. 在bundle 的pom中加入此plugin,并添加po中可能存在的依赖的其他bundle,比如字段类型是否使用了其他bundle的枚举类型
[img]http://dl2.iteye.com/upload/attachment/0098/7835/a0491caa-0b33-314d-890d-4e3e2ddfe052.jpg[/img]
3.执行 maven install命令
4. 在bundle的target下的daodoc.htm就是生成的数据库文档
[img]http://dl2.iteye.com/upload/attachment/0098/7837/b5749d86-cde8-3518-a638-6c8c0f9fa075.jpg[/img]
下一步
1. 将comment注解改为类级也可用,这样数据表的含义也可自动生成了
2. 将此功能插件改造为hudson插件,在做正式版本发版时生成数据库文档并提交到svn
[b]源代码中带有某些公司信息,需要者可以留邮箱,我再做一个版本发给大家[/b]
生成后所有表都在一个html中:
[img]http://dl2.iteye.com/upload/attachment/0098/7831/1b1231da-0bca-3c64-ba3c-ffdfad5ef103.jpg[/img]
基本思想:
在po中将字段上的注释改为注解形式,并通过解析其他JPA注解最终形成数据库文档。
功能: 生成数据库文档
使用方法(注意:如果只是使用的话,不必从svn中检出此插件代码,插件已deploy到maven仓库中)
1.修改po中的注释形式 由图中下面的形式改为上面注解的形式。
[img]http://dl2.iteye.com/upload/attachment/0098/7833/7dacb68b-709b-3c29-b041-5dc9ea40245a.jpg[/img]
2. 在bundle 的pom中加入此plugin,并添加po中可能存在的依赖的其他bundle,比如字段类型是否使用了其他bundle的枚举类型
[img]http://dl2.iteye.com/upload/attachment/0098/7835/a0491caa-0b33-314d-890d-4e3e2ddfe052.jpg[/img]
3.执行 maven install命令
4. 在bundle的target下的daodoc.htm就是生成的数据库文档
[img]http://dl2.iteye.com/upload/attachment/0098/7837/b5749d86-cde8-3518-a638-6c8c0f9fa075.jpg[/img]
下一步
1. 将comment注解改为类级也可用,这样数据表的含义也可自动生成了
2. 将此功能插件改造为hudson插件,在做正式版本发版时生成数据库文档并提交到svn
[b]源代码中带有某些公司信息,需要者可以留邮箱,我再做一个版本发给大家[/b]