本篇文章基於"Java開發小技巧(二):自定義Maven依賴"中創建的父工程``project-monitor``實現,運用我們自定義的依賴包進行多工程依賴項目的開發。 ...
前言
本篇文章基於Java開發小技巧(二):自定義Maven依賴中創建的父工程project-monitor
實現,運用我們自定義的依賴包進行多工程依賴項目的開發。
下麵以多可執行Jar包項目的開發為例,進行Maven多工程依賴項目開發的講解。
需求分析
首先來看一下封面圖,我們要實現的效果是:
1.多個項目共用一個項目的類和方法等通用內容
2.每個子項目單獨導入所需依賴,以及各自填充父項目配置文件中的占位符
3.子項目按指定目錄結構進行打包
4.所有子項目集成打包到一個統一的目錄,共用依賴包和配置文件等內容
5.打包後目錄結構:
- bin:存放腳本文件,用來設置環境變數,執行相應的jar包
- lib:依賴、項目jar包
- etc:配置文件
- ......
好啦,目標明確的,接下來要進行具體開發實現了
實現
打包配置
在上一篇文章中已經創建好了一個自定義的Maven依賴,相當於一個父項目,接下來我們新建一個子項目,命名為project-one
,pom.xml
文件與父項目基本相同,所有依賴包都必須單獨引入,不同的是多了對父項目的依賴:
<dependency>
<groupId>com.demo</groupId>
<artifactId>project-monitor</artifactId>
<version>0.0.1</version>
</dependency>
以及Maven插件maven-assembly-plugin
的引入,用來實現依賴的打包以及打包後的目錄結構:
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<appendAssemblyId>false</appendAssemblyId>
<descriptors>
<descriptor>package.xml</descriptor>
</descriptors>
</configuration>
<executions>
<execution>
<id>make-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
</plugin>
目錄結構配置位於項目根目錄下package.xml
配置文件中:
<assembly xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0http://maven.apache.org/xsd/assembly-1.0.0.xsd">
<id>package</id>
<formats>
<format>zip</format>
</formats>
<includeBaseDirectory>true</includeBaseDirectory>
<fileSets>
<fileSet>
<directory>src/main/resources</directory>
<includes>
<include>*.properties</include>
<include>*.xml</include>
</includes>
<outputDirectory>etc</outputDirectory>
</fileSet>
</fileSets>
<dependencySets>
<dependencySet>
<outputDirectory>lib</outputDirectory>
<scope>runtime</scope>
</dependencySet>
</dependencySets>
</assembly>
以上就實現了項目打包的配置工作,實現流程圖中最後的項目結構,打包結果為zip文件
填充配置文件占位符
之前我們在父項目的spring上下文中定義了一個數據源bean,配置信息使用了占位符填充,所以如果我們想要使用這個bean,就需要替換其中的占位符信息,要怎麼做呢?
首先當然是創建配置文件了,在項目中創建jdbc.properties
JDBC配置文件,如:
jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localdb:3306/test?characterEncoding=utf8&useSSL=true&serverTimezone=UTC
jdbc.username=root
jdbc.password=5EF28C5A9A0CE86C2D231A526ED5B388
然後我們需要藉助PropertyPlaceholderConfigurer
這個類來實現,在項目spring上下文中定義bean:
<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="locations">
<value>classpath:jdbc.properties</value>
</property>
<property name="ignoreResourceNotFound" value="false"/>
</bean>
Bingo,占位符修改完畢,別忘了引入父項目的上下文,畢竟我們要填充占位符的bean是在父項目中的:
<import resource="classpath*:project-monitor.xml"/>
測試Demo
好了,接下來來測試項目的可行性,主要實現使用父項目定義的數據源來對MySql進行查詢。
先創建一個DemoService
類,內容如下:
package com.demo.project.one.service;
import org.apache.log4j.Logger;
import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
public class DemoService {
private static final Logger logger = Logger.getLogger(DemoService.class);
private DataSource dataSource;
public void queryDb(){
Connection conn = null;
Statement stmt = null;
ResultSet rs = null;
try {
conn = dataSource.getConnection();
stmt = conn.createStatement();
rs = stmt.executeQuery("select * from movie limit 1");
while(rs.next()){
logger.info(String.format("Movie[Id=%d,Title=%s,Director=%s,Genre=%s,Language=%s]",
rs.getInt(1),
rs.getString(2),
rs.getString(3),
rs.getString(4),
rs.getString(5)
));
}
} catch (SQLException e) {
e.printStackTrace();
} finally {
try {
if(rs != null){
rs.close();
}
if(stmt != null){
stmt.close();
}
if(conn != null){
conn.close();
}
} catch (SQLException e) {
e.printStackTrace();
}
}
}
public void setDataSource(DataSource dataSource) {
this.dataSource = dataSource;
}
}
在上下文中為其註入dataSource定義:
<bean id="demoService" class="com.demo.project.one.service.DemoService">
<property name="dataSource" ref="dataSource"/>
</bean>
別忘了添加log4j.properties
配置文件,這裡就不貼出文件內容了。
OK,新建一個入口類來執行DemoService
的測試吧:
package com.demo.project.one;
import com.demo.project.one.service.DemoService;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class Application {
public static void main(String[] args){
ConfigurableApplicationContext context = new ClassPathXmlApplicationContext("/project-one.xml");
DemoService demoService = (DemoService)context.getBean("demoService");
demoService.queryDb();
}
}
最終的項目結構如圖
打包
一切準備就緒,輪到項目打包了,在項目根目錄執行以下Maven命令即可
mvn clean package
執行完成後你會發現target
目錄的結構如圖所示
project-one.zip就是我們要的打包結果,解壓後你會發現,依賴包和配置文件已經放在了各自的目錄下
執行文件
項目開發完成,接下來就是執行程式了,以Windows平臺下為例,首先創建bin
目錄,目錄中創建批處理文件setenv.bat
、project-one.bat
因為jar包與配置文件的分離,所以我們需要指定執行jar包時的classpath
,批處理文件內容如下:
setenv.bat
@echo off
set SRC_DIR=%cd%
cd %~dp0
cd ..
set MAIN_HOME=%cd%
cd %SRC_DIR%
set BIN_HOME=%MAIN_HOME%\bin
set ETC_HOME=%MAIN_HOME%\etc
set LIB_HOME=%MAIN_HOME%\lib
set CLASSPATH=%ETC_HOME%;%JAVA_HOME%\lib\tools.jar
for %%i in (%LIB_HOME%\*.jar) do set CLASSPATH=!CLASSPATH!;%%i
project-one.bat
@echo off
@setlocal enableextensions enabledelayedexpansion
call setenv.bat
chcp 65001
java -cp %CLASSPATH% com.demo.project.one.Application
pause
bat文件的內容就不詳細解釋,有興趣可以百度瞭解一下,主要是為了拼接出完整的CLASSPATH
,執行project-one-0.0.1.jar
可執行jar包
運行
點擊project-one.bat
運行程式
結語
項目終於開發演示完畢,這裡只是創建一個打造可執行jar包的子項目作為例子,你還可以創建多個子項目,最後打包的時候合併相同的依賴和配置文件,然後在bin
中創建相應項目的執行文件即可,各個子項目之間也可進行相互依賴。
以上開發技巧不僅適用於可執行jar包的開發,同樣適用於WEB項目的開發,具體還是由項目需求決定。
文章項目源碼已發佈到Github:https://github.com/ZKHDEV/MultDependPjo
本文為作者kMacro原創,轉載請註明來源:http://www.jianshu.com/p/3fa98dd52520。