Spring Boot Gradle 工程模板

• 用于快速创建一个SpringBoot工程
• Github Home

模块说明

目录	子工程名	说明
web/springboot-demo	springboot-demo	大量的SpringBoot使用示例
web/archetype	web-archetype	WEB子工程原型(Spring Boot)
module/archetype	module-archetype	模块子工程原型(Java Library)

内含一些示例程序

• Spring及第三方组件的使用示例: web/demo/src/main/java/com/github/shepherdviolet/webdemo/demo

利用本模板创建工程

新建工程

Windows环境新建工程

• 浏览器访问如下地址, 手动下载sprintboot-startup.bat脚本:

https://raw.githubusercontent.com/shepherdviolet/spring-boot-template/master/extra/quickstart/springboot-startup.bat

• 执行下载来的脚本sprintboot-startup.bat, 输入新工程名称, 控制台输出如下:

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Startup a SpringBoot Gradle Project
1.Clone spring-boot-template from remote
2.Delete the original .git
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Enter new project name:foo
Processing ...
Cloning into 'foo'...
......
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Finished
Read 'foo\README.md' to create sub-project automatically
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
请按任意键继续. . .

• Done!

Linux环境新建工程

• 命令行执行如下命令, 其中foo为新工程名称, P.S. Windows环境用cmder也可以这么做

curl -L https://raw.githubusercontent.com/shepherdviolet/spring-boot-template/master/extra/quickstart/springboot-startup.sh | sh -s foo

• 输入新工程名称, 等待新工程创建完毕
• Done!

其他环境新建工程(手动)

• 克隆: git clone https://github.com/shepherdviolet/spring-boot-template.git foo
• 删除新工程目录下的.git(删除原来模板工程的版本数据)
• Done!

根据原型生成子工程

• 在工程根目录build.gradle文件的末尾添加如下内容:

// 子工程创建器配置
ext.project_creator = [
        // 需要创建的子工程清单
        'projects': [
                // [KEY修改] 子工程路径
                'web/app': [
                        // [VALUE修改] 原型路径
                        'archetype_path': 'web/archetype',
                        'replace_context': [
                                // [KEY/VALUE修改] 自定义参数
                                // 包路径
                                'java_package': 'com.company.foo.app',
                                // 主类名
                                'application_class': 'FooApplication',
                                // app.id
                                'app_id': 'foo'
                        ]
                ],
                // [KEY修改] 子工程路径
                'module/core': [
                        // [VALUE修改] 原型路径
                        'archetype_path': 'module/archetype',
                        'replace_context': [
                                // [KEY/VALUE修改] 自定义参数
                                // 包路径
                                'java_package': 'com.company.foo.core'
                        ]
                ]
        ]
]

// [必须] 引入创建子工程的Gradle脚本
apply from: 'gradle/utils/project-creator.gradle'

• 控制台执行gradlew createProject, 生成子工程

• 修改工程根目录的settings.json文件, 将新生成的子工程配置到清单中

{
  "web": {
    "foo-app": "web/app"
  },
  "module": {
    "foo-core": "module/core"
  }
}

• Done! 删除此前build.gradle末尾添加的内容

• P.S.想要了解更多请查看gradle/utils/project-creator.gradle

部署说明

编译

gradlew bootJar

启动

• 方式1: 启动参数按需设置

java -Dspring.profiles.active=linux -Denv=dev -Dlog.path=/your-path/logs -Dserver.tomcat.basedir=/your-path/tmp -jar foo.jar

• 方式2: 启动参数按需设置, -cp后面如果有多个jar包或者是目录, linux用:分割, windows用;分割

java -Dspring.profiles.active=linux -Denv=dev -Dlog.path=/your-path/logs -Dserver.tomcat.basedir=/your-path/tmp -cp foo.jar org.springframework.boot.loader.JarLauncher

IntelliJ IDEA配置建议

运行应用前编译全工程

• IntelliJ在运行应用时, 默认只会编译当前子工程, 不会编译它依赖的子工程. 为了避免代码修改不生效的问题, 我们需要改成编译全工程.

找到运行应用的地方 -- Edit Configurations... -- 左边'Templates'里找到'Application'和'Spring Boot', 
把他们的'Before Launch'从'Build'改成'Build Project'

找到运行应用的地方 -- Edit Configurations... -- 选择你的应用启动配置, 
把他们的'Before Launch'从'Build'改成'Build Project'

设置编码

File -- Settings -- Editor-- File Encodings
全都改成UTF-8, 把'Transparent native-to-ascii conversion'勾上

File -- Settings -- Tools -- SSH Terminal
修改为UTF-8

检测和生成Serializable类的serialVersionUID

File -- Settings -- Editor -- Inspections -- Serialization issues[在java类目下] -> 选中 Serializable class without 'serialVersionUID'