基于模板使用giter8创建项目

背景

进行分布式服务开发, 各服务均划分了各自的消息协议项目/应用服务项目, 这些项目骨架相同, 仅仅是项目名和包名有个别字的区别; 为此, 笔者经过调研后选择使用giter8来创建项目骨架模板, 后期项目均使用该模板生成项目.

安装giter8

笔者仅介绍OSX的安装方法, 其它平台的安装详见:

1
brew install giter8

创建模板

创建模板的规则和最佳实践

  1. 项目名必须以.g8结尾
  2. 项目模板放置于src/main/g8目录下, 若该目录不存在, 使用项目根目录取而代之(不推荐)
  3. 模板中的default.properties定义待输入的变量和默认值
    • 属性可以放置在任何地方, 文件内容/文件名/路径
    • name熟悉兼做项目创建时的目录名
    • package属性用在路径上时会进行目录展开
    • description定义的字符串会首先被g8显示出来
  4. 由于使用git无法提交空目录, 针对有目录为空的目录, 在其内添加文件.gitkeep

模板样例

使用模板创建项目

  • 本地: g8 file:///Users/arccode/workspace/github/rest-api-protocol-template.g8
  • github: g8 arccode/rest-api-protocol-template.g8

参考文章

转载

本文出自<<arccode>>, 欢迎转载, 转载请注明出处.