简述
前情回顾
在前面的章节中,我们介绍了项目结构树,相信大家应该对微服务的项目结构树的构建有一些了解了。那我们接下来的章节我们将按照Spring Cloud的树形结构来构建我们的POM。
准备工作
前文已阐述,本系列将以Maven为主,Gradle也会有所涉猎。下面的步骤对Gradle其实是类似的,只是不再单独累述。
安装Maven
安装Maven其实比较简单,本机要先安装Java的运行环境,亦即JDK。JDK的安装在前文已有阐述,不再多说。
需要说明的是,由于本人的环境为MacOS,如果是Windows环境的,还请自行按照官方Guide进行安装配置。
下载Maven
我们还是依旧推荐官网下载最新稳定版。
http://maven.apache.org/
下载后,解压到自己的所想要的工具目录即可,一下是本人的习惯,专门为日常工具创建Tools目录,将Maven存于该目录。
➜ Tools pwd
/Users/chenxj/Documents/Tools
➜ Tools
➜ Tools ls -al | grep Maven
drwxr-xr-x@ 10 chenxj staff 320 May 4 2017 Maven-3.5.0
➜ Tools
➜ Tools ls -al Maven*
total 88
drwxr-xr-x@ 10 chenxj staff 320 May 4 2017 .
drwxr-xr-x 139 chenxj staff 4448 Mar 29 22:51 ..
-rw-r--r--@ 1 chenxj staff 8196 Mar 9 23:35 .DS_Store
-rw-r--r--@ 1 chenxj staff 20934 Apr 3 2017 LICENSE
-rw-r--r--@ 1 chenxj staff 182 Apr 3 2017 NOTICE
-rw-r--r--@ 1 chenxj staff 2544 Apr 3 2017 README.txt
drwxr-xr-x@ 8 chenxj staff 256 Apr 3 2017 bin
drwxr-xr-x@ 3 chenxj staff 96 Apr 3 2017 boot
drwxr-xr-x@ 5 chenxj staff 160 Apr 3 2017 conf
drwxr-xr-x@ 83 chenxj staff 2656 Apr 3 2017 lib
➜ Tools
配置Maven环境变量
将Maven添加到环境变量。
➜ vi /etc/profile
......
export M2_HOME=/Users/chenxj/Documents/Tools/Maven-3.5.0
export PATH=.:$PATH:$M2_HOME/bin:$ANT_HOME/bin:$JAVA_HOME/bin:$MYSQL_HOME/bin
......
➜ source /etc/profile
配置完毕后,执行mvn命令,如果能正常出来一下信息,说明Maven已安装成功。如果安装失败,还请查看JDK环境变量和Maven环境变量,基本都是这些信息没有配置正确。
➜ ~ mvn --version
Apache Maven 3.5.0 (ff8f5e7444045639af65f6095c62210b5713f426; 2017-04-04T03:39:06+08:00)
Maven home: /Users/chenxj/Documents/Tools/Maven-3.5.0
Java version: 1.8.0_60, vendor: Oracle Corporation
Java home: /Library/Java/JavaVirtualMachines/jdk1.8.0_60.jdk/Contents/Home/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "mac os x", version: "10.14.2", arch: "x86_64", family: "mac"
➜ ~
至此,我们的Maven工具已安装并配置完毕,接下来,我们将开始将Maven接入我们的私有Maven仓库。
配置Maven
我们接下来的配置,主要围绕Maven的settings.xml进行。
➜ Maven-3.5.0 pwd
/Users/chenxj/Documents/Tools/Maven-3.5.0/conf
➜ conf vi settings.xml
......
设置本地Maven目录
一般情况,我们会制定一个本地的目录用来存放Maven工具在编译过程中从Maven仓库下载的Jar包,修改settings.xml中的本地存储路径。
本步骤非必须,如果不修改,Maven将采用默认路径,存放在${user.home}/.m2/repository中。
/Users/chenxj/Documents/Maven_Repo
增加私有Server
增加Maven私有Repo Server
我们将前面章节部署的私有Maven Repo Server添加到Server列表。
找到settings.xml中的标签,增加一个.
......
twinkle-nexus-releases
cxj110
******
twinkle-nexus-snapshots
cxj110
******
......
增加Maven私有Docker Hub Server
我们将前面章节部署的私有Harbor 镜像仓库添加到Server列表。
找到settings.xml中的标签,增加一个.
......
twinklecloud-hub
admin
******
cxj_hit@126.com
......
增加私有Maven Repo Mirror
找到settings.xml中的标签,增加.
......
twinkle-nexus
*
http://mvn-repo.twikle.net:9881/repository/maven-public/
准备项目POM树
我们将采用Spring Cloud的项目结构树进行后续的教程。Dubbo的后续将以附录的形式展现。
准备项目Root Pom
我们接下来的小节将详述Pom中的各个部分的信息。
创建项目根目录twinkle-cloud,在该目录下创建pom.xml. (可以从其它项目拷贝pom.xml过来,将其中的内容全部清理掉。)
添加项目信息
在pom文件的根标签下,增加项目信息。
4.0.0
com.twinkle.cloud
twinkle-cloud
0.1.0 ---项目版本,亦可SNAPSHOT结尾来标示属于研发快照版本
pom
Twinkle Cloud - Twinkle Root
Twinkle Cloud Platform (Include SAAS and Private PAAS).
添加子module
添加子module需要在根目录twinkle-cloud目录中创建各个module的子目录。
➜ twinkle-cloud git:(master) ✗ ls -al
total 64
drwxr-xr-x 14 chenxj staff 448 Apr 1 16:09 .
drwxr-xr-x 20 chenxj staff 640 Feb 11 16:38 ..
-rw-r--r--@ 1 chenxj staff 6148 Mar 6 11:42 .DS_Store
drwxr-xr-x 12 chenxj staff 384 Apr 1 16:20 .git
-rw-r--r-- 1 chenxj staff 47 Dec 28 10:56 .gitignore
drwxr-xr-x 12 chenxj staff 384 Apr 1 16:18 .idea
-rw-r--r-- 1 chenxj staff 54 Dec 28 10:52 README.md
drwxr-xr-x 2 chenxj staff 64 Nov 8 15:45 parent
-rw-r--r-- 1 chenxj staff 13442 Apr 1 16:09 pom.xml
drwxr-xr-x 3 chenxj staff 96 Apr 1 15:00 twinkle-api
drwxr-xr-x 10 chenxj staff 320 Apr 1 15:00 twinkle-baseplatform
drwxr-xr-x 9 chenxj staff 288 Apr 1 15:00 twinkle-common
drwxr-xr-x 3 chenxj staff 96 Apr 1 15:00 twinkle-composite
drwxr-xr-x 6 chenxj staff 192 Apr 1 15:00 twinkle-core
➜ twinkle-cloud git:(master) ✗
每个Module目录中,需要创建属于自己的POM,随后小节描述。子目录创建完毕后,根Root POM 即可添加如下modules。
twinkle-common
twinkle-baseplatform
twinkle-core
twinkle-composite
twinkle-api
添加父POM引用
由于我们的基础框架是基于Spring Cloud而搭建,所以我们需要引用Spring Cloud的pom为父Pom。
org.springframework.cloud
spring-cloud-starter-parent
Finchley.SR2
定义常用Properties
在本小节,我们主要用来把系统的一些常见参数定义下,其中主要包括:
项目的字符编码等信息。
后面容器所用的镜像版本。
容器镜像中心。
第三方包的版本。
UTF-8
UTF-8
1.8
0.1.0
latest
0.0.1
0.1.0
1.0.0
twinklecloud-hub
hub.twikle.net:8443
https://hub.twikle.net:8443
twinklecloud
dev
Finchley.RC2
1.18.4
1.5.0-b01
2.6.0
2.10.1
3.8.1
4.1
1.9.3
1.21
3.3.3
5.2
1.0.2.Final
6.0.13.Final
2.0.1.Final
2.9.2
2.3.1
0.9.1
3.11.0
2.1.1
1.2.10
增加不同环境的Profile
可以在Maven编译的时候,指定相应的Profile进行编译。依据不同的Profile来获取相应的Properties参数。
dev
development
${kube-dev.version}
test
test
${kube-test.version}
production
production
${kube-pro.version}
增加统一的Lib包引用管理
在根pom中定义全局的lib包依赖(用标签来定义管理),以便于对整个项目集群第三方包的版本管理,不会出现将来整个微服务引用的是这个版本,那个微服务引用的是另一个版本,最后导致服务联调啥的一些潜在问题。
在子的pom中,集成了根pom之后,只需要定义即可。
org.springframework.cloud
spring-cloud-dependencies
${spring-cloud.version}
pom
import
com.twinkle.cloud
twinkle-common-security
${twinklecloud.version}
jar
compile
com.twinkle.cloud
twinkle-common-auth
${twinklecloud.version}
jar
compile
com.twinkle.cloud
twinkle-common-data
${twinklecloud.version}
jar
compile
com.twinkle.cloud
twinkle-common-mybatis
${twinklecloud.version}
jar
compile
com.twinkle.cloud
twinkle-common-utils
${twinklecloud.version}
jar
compile
org.projectlombok
lombok
${lombok.version}
javax.mail
${javamail.version}
joda-time
joda-time
${jodatime.version}
org.apache.commons
commons-pool2
${commonspool.version}
org.apache.commons
commons-lang3
${commonslang.version}
org.apache.commons
commons-collections4
${commonscollection.version}
commons-beanutils
commons-beanutils
${commonbeanutils.version}
com.google.guava
guava
27.0-jre
eu.bitwalker
UserAgentUtils
${bitwalker.version}
com.google.zxing
core
${zxing.version}
com.google.zxing
javase
${zxing.version}
net.logstash.logback
logstash-logback-encoder
${logstash.version}
org.hibernate.javax.persistence
hibernate-jpa-2.1-api
${hibernatejpa.version}
org.hibernate
hibernate-validator
${hibernatevalidator.version}
javax.validation
validation-api
${validationapi.version}
io.jsonwebtoken
jjwt
${jjwt.version}
io.springfox
springfox-swagger2
${springfox.version}
io.springfox
springfox-swagger-ui
${springfox.version}
io.springfox
springfox-spi
${springfox.version}
org.modelmapper
modelmapper
${modelmapper.version}
com.squareup.okhttp3
okhttp
${okhttp3.version}
de.codecentric
spring-boot-admin-server
${codecentric.version}
de.codecentric
spring-boot-admin-server-ui
${codecentric.version}
de.codecentric
spring-boot-admin-starter-client
${codecentric.version}
de.codecentric
spring-boot-admin-starter-server
${codecentric.version}
com.github.pagehelper
pagehelper-spring-boot-starter
${pagehelper.version}
tk.mybatis
mapper-spring-boot-starter
2.0.4
com.github.drtrang
druid-spring-boot2-starter
1.1.10.2
javax.servlet
servlet-api
3.0-alpha-1
定义全局引用lib
在上面的小节中,定义了全局引用lib包的版本,在本小节中,我们只需要定义引用即可(无须再指定版本),在根pom中定义的引用,将被子pom自动继承。
org.springframework.cloud
spring-cloud-starter-config
net.logstash.logback
logstash-logback-encoder
定义Maven Nexus仓储中心
我们定义两个repo以存放我们的项目自身编译出来的微服务版本,这个地址,其实就是前面第4章节中所描述的Maven的Repo中心。
twinkle-nexus-releases
Nexus Release Repository
http://mvn-repo.twinkle.net:9881/repository/maven-releases/
twinkle-nexus-snapshots
Nexus Snapshot Repository
http://mvn-repo.twinkle.net:9881/repository/maven-snapshots/
至此,我们将根pom定义完毕,有关子pom的定义相对简单,在此就不做累述。将完整的POM树已更新到Githup。地址请参考:https://github.com/cxj110/twinkle-cloud