MyCat 1.6部署编译构建环境
简单来说,编译(compile)是用javac编译器将.java源代码编译成.class中间码的动作;而构建(build)则是不止将源代码编译,还包括编译后执行开发者指定的测试、将所有.class打包成.jar包的动作,以及编译前和编译时所遇到的工具、包依赖的分析和下载问题。
下面以Windows 7+下面的软件,将MyCat 1.6(Mycat-server)从源代码构建成一个如同官方release的可运行的jar。整个过程最关键的几步需要联网,而且Eclipse(内置的Maven)会下载约650MB的依赖包和插件,总耗时在3小时~10小时不等(绝大部分时间都花在下载上)。
Eclipse Neon.3 4.6.3
Mycat-server 1.6 brach
安装配置Eclipse
从Eclipse官网下载并解压eclipse-java-neon-3-win32-x86_64.zip到本地目录中,整个安装就是这么简单。
配置Maven(Ecplise内置)
Maven是个强大的项目构建工具,在这里我们只关注它分析、自动下载依赖包的功能。Eclipse内嵌了Maven,但这里直接使用默认配置会有两个不方便:
默认只从Apache的中央库下载,会找不到trilead-ssh2的build221等插件或依赖包,我们需要添加其他库(下载源)来下载。
从远程库下载来的项目依赖包和Maven插件默认保存到Windows的用户目录(%USERPROFILE%)的.ms2/repository里,在C盘不充裕也没有做目录移动时,我们更希望把这些下载内容保存到其他空闲盘区。
为此,我们在Eclipse的解压目录里创建settings.xml,添加以下内容,修改<localRepository>标签里的路径为自己机器上的路径,以UTF-8编码保存。
<?xml version="1.0" encoding="UTF-8"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
<!-- 将依赖包/Maven插件下载到下面的目录里 -->
<localRepository>D:\maven_repo</localRepository>
<profiles>
<!-- 定义名叫mycat的配置 -->
<profile>
<id>mycat</id>
<!-- 依赖包库(下载源) -->
<repositories>
<repository>
<id>nexus</id>
<name>local private nexus</name>
<url>http://nexus.mycat.io/content/groups/public</url>
</repository>
<repository>
<id>java.net</id>
<url>https://maven.java.net/content/repositories/public</url>
</repository>
<repository>
<id>JBoss repository</id>
<url>http://repository.jboss.org/nexus/content/groups/public</url>
</repository>
<repository>
<id>Jenkins ci</id>
<url>http://repo.jenkins-ci.org/releases</url>
</repository>
</repositories>
<!-- Maven插件库(下载源) -->
<pluginRepositories>
<pluginRepository>
<id>nexus</id>
<url>http://nexus.mycat.io/content/groups/public</url>
</pluginRepository>
<pluginRepository>
<id>java.net</id>
<url>https://maven.java.net/content/repositories/public</url>
</pluginRepository>
<pluginRepository>
<id>JBoss pluginRepository</id>
<url>http://pluginRepository.jboss.org/nexus/content/groups/public</url>
</pluginRepository>
<pluginRepository>
<id>Jenkins ci</id>
<url>http://repo.jenkins-ci.org/releases</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
<activeProfiles>
<!-- 启用上面定义的mycat配置 -->
<activeProfile>mycat</activeProfile>
</activeProfiles>
</settings>
配置Eclipse
先启动Eclipse,进入到主界面后,通过Window->Prferences,打开配置窗口。
找到Java->Installed JREs,看看本机的Java 8安装目录是否被识别了,没有的话,点击Add按钮来添加(添加后记得选中它,并且点击右下角的Apply按钮)。** 虽然这里叫做JRE,但由于我们需要编译MyCat,所以必须指向的是JDK。 **
找到Maven->User Settings,点击User Setting的Browse ...按钮,选择我们上面创建的settings.xml文件,然后依次点击Update Settings按钮和Reindex按钮来让settings.xml生效。如果Local Repository是否已经变成了settings.xml中<localRepository>中的值,那么说明配置成功,点击Apply按钮之后,OK关闭配置窗口。
下载Mycat-server源代码
到Github.com下载MyCATApache/Mycat-Server的1.6源代码到本地并解压。
在Eclipse中导入Mycat-server
回到Eclipse中,File->Import...打开导入项目对话框,选择Maven->Existing Maven Projects,点击Next按钮。
点击Root Directory的Browse...按钮,选择解压后的MyCat 1.6根目录,选择Finish,开始导入。** 导入过程中,如果MayCat的依赖包和Maven插件不在本地库里,Maven会从外部库下载,因此第一次导入会非常耗时并需要全程联网。 ** 在电信10M光纤,无任何加速或者科学手段下,第一次导入基本都要用2个多小时。不过下载好了之后,以后导入需要相同包的应用或者再次导入MyCat自己时,就不再需要下载了。所以在下载过程中卡住了的话,杀掉Eclipse进程,重新打开Ecplise,删除导入了只有一半的Mycat-server项目,再重新导入就能继续下去了。
修改Mycat-server的pom.xml:增加源代码的编码声明(可选)
Mycat-server的pom.xml没有定义源代码的编码方式。在编译过程中,Maven会报“Using platform encoding (某某编码 actually) to copy filtered resources, i.e. build is platform dependent!”这样的WARNING。虽然目前并不影响编译,但很难说以后Mycat-server会不会有内嵌的非ASCII字符集的多国语言存在,所以最好还是修改解压后的MyCat根目录里的pom.xml,在<app.encoding>标签下增加以下一行,来让Maven按UTF-8来理解源代码。
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
修改Mycat-server的pom.xml:增加Maven插件的版本声明(可选)
Mycat-server的pom.xml没有声明maven-jar-plugin和maven-eclipse-plugin的所需版本。在编译过程中,Maven会因此而报WARNING。这个WARNING没有实质性的影响,但按下面修改解压后的MyCat根目录里的pom.xml避免这个警告。
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.0.2</version><!-- 增加此条目,声明使用的jar插件版本 -->
<configuration>
<excludes>
<exclude>**/.svn/**</exclude>
</excludes>
</configuration>
<executions>
<execution>
<goals>
<goal>test-jar</goal>
</goals>
<!-- configuration> <finalName>${project.build.finalName}-${buildNumber}</finalName>
</configuration -->
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-eclipse-plugin</artifactId>
<version>2.10</version><!-- 增加此条目,声明使用的eclipse插件版本 -->
<configuration>
<sourceExcludes>
<sourceExclude>**/.svn/**</sourceExclude>
</sourceExcludes>
<downloadSources>true</downloadSources>
<outputDirectory>classes</outputDirectory>
<additionalConfig>
<file>
<name>.settings/org.eclipse.core.resources.prefs</name>
<content>
<![CDATA[eclipse.preferences.version=1${line.separator}encoding/<project>=${app.encoding}${line.separator}]]>
</content>
</file>
</additionalConfig>
</configuration>
</plugin>
新增构建配置(build configuration)
在Ecplise的主界面上,选中Mycat-server项目,再在工具栏Run->Run Configurations...,打开构建配置管理界面。
双击界面中的Maven Build,等它自动创建一个叫New_configuration的新配置。然后按下面修改这个新配置,再点Apply把修改部分保存:
修改Name栏,给这个“New_configuration”配置起个新名字
点击Base diretory下的Workspace...按钮,选择Mycat-server项目然后按OK,以Mycat-server的根目录为基准目录
在Goals栏,输入clean install,指明Maven对这个项目构建时,执行pom中定义的clean和install所属操作(Maven的goal概念,类似Makefile体系的make install中的install)
在界面中间的一大堆复选框中,我们只选中Debug Output和Skip Tests——Debug Ouput能够丰富Maven构建项目时的输出信息,万一碰到错误也有迹可查;Skip Tests让Maven跳过Mycat-server定制的测试项目,测试的输出很多而且很复杂,我们目前仅需要编译出MyCat的jar包,所以我们应该跳过测试。
继续在同一界面里,点击Common选项卡,进行以下修改,最后点击Apply保存:
点击Encoding框的Other单选下拉框,选中UTF-8来让Eclipse的Console窗口以UTF-8去理解Maven的输出,这样才能使Eclipse正确显示Mycat-server项目里的中文提示
选中Standard Input and Output框中的Output File单选框,然后点击Workspace...按钮,选中Mycat-server项目后OK,再在文本框新出现的“"${workspace_loc:/Mycat-server}”后面键盘输入“/eclipse_console.log”。于是在构建过程中的所有信息(INFO、WARNNING等)不仅在Console窗口显示,也会写入到Mycat-server项目根目录上的eclipse_console.log的构建日志(自动创建文件)里。Console窗口的显示范围是有限的,构建信息很多的时候,通过查构建日志就能找回最近一次构建的所有信息,方便解决问题;此外,默认每次构建都会自动清空上一次的构建日志,也不用害怕无限占用磁盘空间。
编译源代码并构建jar包
最后我们点击界面上的Run按钮,Ecplise就会调用Maven,先清除可能的残留文件,再构建MyCat 1.6的jar包。
构建Mycat-server还需要用到别的一些Maven插件和依赖包。第一次编译,Maven还会进一步分析和下载这些依赖,所以这又是一个漫长的过程——比上一次下载用时要略短,但也得做好花费数十分钟的准备。**但实际的编译和构建用时其实很短,日后的构建和编译不需要下载,那其实很快的。
构建完毕后,Ecplise的Console窗口会有如下显示来提示构建工作完成。这时候到Mycat-server的解压目录里,会发现多了一个target目录,打开里面,就能看到刚刚构建好的MyCat 1.6的jar包了。
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 56.375 s
[INFO] Finished at: 2017-06-01T10:35:34+08:00
[INFO] Final Memory: 38M/734M
[INFO] ------------------------------------------------------------------------