簡(jiǎn)述
前情回顧
在前面的章節(jié)中谬以,我們介紹了項(xiàng)目結(jié)構(gòu)樹(shù)几缭,相信大家應(yīng)該對(duì)微服務(wù)的項(xiàng)目結(jié)構(gòu)樹(shù)的構(gòu)建有一些了解了派桩。那我們接下來(lái)的章節(jié)我們將按照Spring Cloud的樹(shù)形結(jié)構(gòu)來(lái)構(gòu)建我們的POM腾誉。
準(zhǔn)備工作
前文已闡述,本系列將以Maven為主组砚,Gradle也會(huì)有所涉獵吻商。下面的步驟對(duì)Gradle其實(shí)是類(lèi)似的,只是不再單獨(dú)累述糟红。
安裝Maven
安裝Maven其實(shí)比較簡(jiǎn)單艾帐,本機(jī)要先安裝Java的運(yùn)行環(huán)境,亦即JDK盆偿。JDK的安裝在前文已有闡述柒爸,不再多說(shuō)。
需要說(shuō)明的是事扭,由于本人的環(huán)境為MacOS捎稚,如果是Windows環(huán)境的,還請(qǐng)自行按照官方Guide進(jìn)行安裝配置。
下載Maven
我們還是依舊推薦官網(wǎng)下載最新穩(wěn)定版今野。
http://maven.apache.org/
下載后葡公,解壓到自己的所想要的工具目錄即可,一下是本人的習(xí)慣条霜,專(zhuān)門(mén)為日常工具創(chuàng)建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環(huán)境變量
將Maven添加到環(huán)境變量蛔外。
? 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
配置完畢后,執(zhí)行mvn命令溯乒,如果能正常出來(lái)一下信息夹厌,說(shuō)明Maven已安裝成功。如果安裝失敗裆悄,還請(qǐng)查看JDK環(huán)境變量和Maven環(huán)境變量矛纹,基本都是這些信息沒(méi)有配置正確。
? ~ 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工具已安裝并配置完畢或南,接下來(lái),我們將開(kāi)始將Maven接入我們的私有Maven倉(cāng)庫(kù)艾君。
配置Maven
我們接下來(lái)的配置采够,主要圍繞Maven的settings.xml進(jìn)行。
? Maven-3.5.0 pwd
/Users/chenxj/Documents/Tools/Maven-3.5.0/conf
? conf vi settings.xml
......
設(shè)置本地Maven目錄
一般情況冰垄,我們會(huì)制定一個(gè)本地的目錄用來(lái)存放Maven工具在編譯過(guò)程中從Maven倉(cāng)庫(kù)下載的Jar包蹬癌,修改settings.xml中的本地存儲(chǔ)路徑。
本步驟非必須虹茶,如果不修改逝薪,Maven將采用默認(rèn)路徑,存放在${user.home}/.m2/repository中蝴罪。
<localRepository>/Users/chenxj/Documents/Maven_Repo</localRepository>
增加私有Server
增加Maven私有Repo Server
我們將前面章節(jié)部署的私有Maven Repo Server添加到Server列表董济。
找到settings.xml中的<servers>標(biāo)簽,增加一個(gè)<server>.
<servers>
......
<server>
<id>twinkle-nexus-releases</id>
<username>cxj110</username>
<password>******</password>
</server>
<server>
<id>twinkle-nexus-snapshots</id>
<username>cxj110</username>
<password>******</password>
</server>
......
</servers>
增加Maven私有Docker Hub Server
我們將前面章節(jié)部署的私有Harbor 鏡像倉(cāng)庫(kù)添加到Server列表要门。
找到settings.xml中的<servers>標(biāo)簽虏肾,增加一個(gè)<server>.
<servers>
......
<server>
<id>twinklecloud-hub</id>
<username>admin</username>
<password>******</password>
<configuration>
<email>cxj_hit@126.com</email>
</configuration>
</server>
......
</servers>
增加私有Maven Repo Mirror
找到settings.xml中的<mirrors>標(biāo)簽,增加<mirror>.
<mirrors>
......
<mirror>
<id>twinkle-nexus</id>
<mirrorOf>*</mirrorOf>
<url>http://mvn-repo.twikle.net:9881/repository/maven-public/</url>
</mirror>
</mirrors>
準(zhǔn)備項(xiàng)目POM樹(shù)
我們將采用Spring Cloud的項(xiàng)目結(jié)構(gòu)樹(shù)進(jìn)行后續(xù)的教程欢搜。Dubbo的后續(xù)將以附錄的形式展現(xiàn)询微。
準(zhǔn)備項(xiàng)目Root Pom
我們接下來(lái)的小節(jié)將詳述Pom中的各個(gè)部分的信息。
創(chuàng)建項(xiàng)目根目錄twinkle-cloud狂巢,在該目錄下創(chuàng)建pom.xml. (可以從其它項(xiàng)目拷貝pom.xml過(guò)來(lái)撑毛,將其中的內(nèi)容全部清理掉。)
添加項(xiàng)目信息
在pom文件的根<xml>標(biāo)簽下,增加項(xiàng)目信息藻雌。
<modelVersion>4.0.0</modelVersion>
<groupId>com.twinkle.cloud</groupId>
<artifactId>twinkle-cloud</artifactId>
<version>0.1.0</version> ---項(xiàng)目版本雌续,亦可SNAPSHOT結(jié)尾來(lái)標(biāo)示屬于研發(fā)快照版本
<packaging>pom</packaging>
<name>Twinkle Cloud - Twinkle Root</name>
<description>Twinkle Cloud Platform (Include SAAS and Private PAAS).</description>
添加子module
添加子module需要在根目錄twinkle-cloud目錄中創(chuàng)建各個(gè)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) ?
每個(gè)Module目錄中胯杭,需要?jiǎng)?chuàng)建屬于自己的POM驯杜,隨后小節(jié)描述。子目錄創(chuàng)建完畢后做个,根Root POM 即可添加如下modules鸽心。
<modules>
<module>twinkle-common</module>
<module>twinkle-baseplatform</module>
<module>twinkle-core</module>
<module>twinkle-composite</module>
<module>twinkle-api</module>
</modules>
添加父POM引用
由于我們的基礎(chǔ)框架是基于Spring Cloud而搭建,所以我們需要引用Spring Cloud的pom為父Pom居暖。
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-parent</artifactId>
<version>Finchley.SR2</version>
<relativePath/>
<!-- lookup parent from repository Brixton.RELEASE -->
</parent>
定義常用Properties
在本小節(jié)顽频,我們主要用來(lái)把系統(tǒng)的一些常見(jiàn)參數(shù)定義下,其中主要包括:
- 項(xiàng)目的字符編碼等信息太闺。
- 后面容器所用的鏡像版本糯景。
- 容器鏡像中心。
- 第三方包的版本省骂。
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<twinklecloud.version>0.1.0</twinklecloud.version>
<!-- docker images's tag -->
<kubeimage.version>latest</kubeimage.version>
<kube-dev.version>0.0.1</kube-dev.version>
<kube-test.version>0.1.0</kube-test.version>
<kube-pro.version>1.0.0</kube-pro.version>
<!-- latest: for dev env, 0.2.0: for test env -->
<!-- Docker Hub configuration -->
<docker.mvnhup>twinklecloud-hub</docker.mvnhup>
<docker.registry>hub.twikle.net:8443</docker.registry>
<docker.registry.url>https://hub.twikle.net:8443</docker.registry.url>
<docker.image.prefix>twinklecloud</docker.image.prefix>
<!-- active profile, also can be defined in maven's settings.xml, or get from mvn cmd. -->
<profile.active>dev</profile.active>
<!-- 3rd parties libs' version -->
<spring-cloud.version>Finchley.RC2</spring-cloud.version>
<lombok.version>1.18.4</lombok.version>
<javamail.version>1.5.0-b01</javamail.version>
<commonspool.version>2.6.0</commonspool.version>
<jodatime.version>2.10.1</jodatime.version>
<commonslang.version>3.8.1</commonslang.version>
<commonscollection.version>4.1</commonscollection.version>
<commonbeanutils.version>1.9.3</commonbeanutils.version>
<bitwalker.version>1.21</bitwalker.version>
<zxing.version>3.3.3</zxing.version>
<logstash.version>5.2</logstash.version>
<hibernatejpa.version>1.0.2.Final</hibernatejpa.version>
<hibernatevalidator.version>6.0.13.Final</hibernatevalidator.version>
<validationapi.version>2.0.1.Final</validationapi.version>
<springfox.version>2.9.2</springfox.version>
<modelmapper.version>2.3.1</modelmapper.version>
<jjwt.version>0.9.1</jjwt.version>
<okhttp3.version>3.11.0</okhttp3.version>
<codecentric.version>2.1.1</codecentric.version>
<pagehelper.version>1.2.10</pagehelper.version>
</properties>
增加不同環(huán)境的Profile
可以在Maven編譯的時(shí)候蟀淮,指定相應(yīng)的Profile進(jìn)行編譯。依據(jù)不同的Profile來(lái)獲取相應(yīng)的Properties參數(shù)钞澳。
<profiles>
<profile>
<id>dev</id>
<properties>
<spring.profiles.active>development</spring.profiles.active>
<kubeimage.version>${kube-dev.version}</kubeimage.version>
</properties>
</profile>
<profile>
<id>test</id>
<properties>
<spring.profiles.active>test</spring.profiles.active>
<kubeimage.version>${kube-test.version}</kubeimage.version>
</properties>
</profile>
<profile>
<id>production</id>
<properties>
<spring.profiles.active>production</spring.profiles.active>
<kubeimage.version>${kube-pro.version}</kubeimage.version>
</properties>
</profile>
</profiles>
增加統(tǒng)一的Lib包引用管理
在根pom中定義全局的lib包依賴(lài)(用<dependencyManagement>標(biāo)簽來(lái)定義管理)怠惶,以便于對(duì)整個(gè)項(xiàng)目集群第三方包的版本管理同波,不會(huì)出現(xiàn)將來(lái)整個(gè)微服務(wù)引用的是這個(gè)版本奸例,那個(gè)微服務(wù)引用的是另一個(gè)版本,最后導(dǎo)致服務(wù)聯(lián)調(diào)啥的一些潛在問(wèn)題金麸。
在子的pom中逃延,集成了根pom之后览妖,只需要定義<dependencies>即可。
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>com.twinkle.cloud</groupId>
<artifactId>twinkle-common-security</artifactId>
<version>${twinklecloud.version}</version>
<type>jar</type>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.twinkle.cloud</groupId>
<artifactId>twinkle-common-auth</artifactId>
<version>${twinklecloud.version}</version>
<type>jar</type>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.twinkle.cloud</groupId>
<artifactId>twinkle-common-data</artifactId>
<version>${twinklecloud.version}</version>
<type>jar</type>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.twinkle.cloud</groupId>
<artifactId>twinkle-common-mybatis</artifactId>
<version>${twinklecloud.version}</version>
<type>jar</type>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.twinkle.cloud</groupId>
<artifactId>twinkle-common-utils</artifactId>
<version>${twinklecloud.version}</version>
<type>jar</type>
<scope>compile</scope>
</dependency>
<!--lombok lib-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
</dependency>
<dependency>
<groupId>javax.mail</groupId>
<artifactId>mail</artifactId>
<version>${javamail.version}</version>
</dependency>
<dependency>
<groupId>joda-time</groupId>
<artifactId>joda-time</artifactId>
<version>${jodatime.version}</version>
</dependency>
<!-- Common libs -->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
<version>${commonspool.version}</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>${commonslang.version}</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-collections4</artifactId>
<version>${commonscollection.version}</version>
</dependency>
<dependency>
<groupId>commons-beanutils</groupId>
<artifactId>commons-beanutils</artifactId>
<version>${commonbeanutils.version}</version>
</dependency>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>27.0-jre</version>
</dependency>
<!--?Browser related lib -->
<dependency>
<groupId>eu.bitwalker</groupId>
<artifactId>UserAgentUtils</artifactId>
<version>${bitwalker.version}</version>
</dependency>
<!--?QR Code related libs -->
<dependency>
<groupId>com.google.zxing</groupId>
<artifactId>core</artifactId>
<version>${zxing.version}</version>
</dependency>
<dependency>
<groupId>com.google.zxing</groupId>
<artifactId>javase</artifactId>
<version>${zxing.version}</version>
</dependency>
<!--?logstash log formatter lib -->
<dependency>
<groupId>net.logstash.logback</groupId>
<artifactId>logstash-logback-encoder</artifactId>
<version>${logstash.version}</version>
</dependency>
<!--Hibernate JPA support.-->
<dependency>
<groupId>org.hibernate.javax.persistence</groupId>
<artifactId>hibernate-jpa-2.1-api</artifactId>
<version>${hibernatejpa.version}</version>
</dependency>
<!--Validation support.-->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>${hibernatevalidator.version}</version>
</dependency>
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>${validationapi.version}</version>
</dependency>
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt</artifactId>
<version>${jjwt.version}</version>
</dependency>
<!-- Swagger2 libs -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${springfox.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${springfox.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-spi</artifactId>
<version>${springfox.version}</version>
</dependency>
<dependency>
<groupId>org.modelmapper</groupId>
<artifactId>modelmapper</artifactId>
<version>${modelmapper.version}</version>
</dependency>
<dependency>
<groupId>com.squareup.okhttp3</groupId>
<artifactId>okhttp</artifactId>
<version>${okhttp3.version}</version>
</dependency>
<!--Spring boot admin lib. -->
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-server</artifactId>
<version>${codecentric.version}</version>
</dependency>
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-server-ui</artifactId>
<version>${codecentric.version}</version>
</dependency>
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-starter-client</artifactId>
<version>${codecentric.version}</version>
</dependency>
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-starter-server</artifactId>
<version>${codecentric.version}</version>
</dependency>
<!-- MyBatis Page Support -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>${pagehelper.version}</version>
</dependency>
<!-- 通用mapper -->
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
<version>2.0.4</version>
</dependency>
<!-- druid -->
<dependency>
<groupId>com.github.drtrang</groupId>
<artifactId>druid-spring-boot2-starter</artifactId>
<version>1.1.10.2</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>3.0-alpha-1</version>
</dependency>
</dependencies>
</dependencyManagement>
定義全局引用lib
在上面的小節(jié)中揽祥,定義了全局引用lib包的版本讽膏,在本小節(jié)中,我們只需要定義引用即可(無(wú)須再指定版本)拄丰,在根pom中定義的引用府树,將被子pom自動(dòng)繼承。
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
<groupId>net.logstash.logback</groupId>
<artifactId>logstash-logback-encoder</artifactId>
</dependency>
</dependencies>
定義Maven Nexus倉(cāng)儲(chǔ)中心
我們定義兩個(gè)repo以存放我們的項(xiàng)目自身編譯出來(lái)的微服務(wù)版本料按,這個(gè)地址奄侠,其實(shí)就是前面第4章節(jié)中所描述的Maven的Repo中心。
<distributionManagement>
<repository>
<id>twinkle-nexus-releases</id>
<name>Nexus Release Repository</name>
<url>http://mvn-repo.twinkle.net:9881/repository/maven-releases/</url>
</repository>
<snapshotRepository>
<id>twinkle-nexus-snapshots</id>
<name>Nexus Snapshot Repository</name>
<url>http://mvn-repo.twinkle.net:9881/repository/maven-snapshots/</url>
</snapshotRepository>
</distributionManagement>
至此载矿,我們將根pom定義完畢垄潮,有關(guān)子pom的定義相對(duì)簡(jiǎn)單,在此就不做累述。將完整的POM樹(shù)已更新到Githup弯洗。地址請(qǐng)參考:https://github.com/cxj110/twinkle-cloud