自定義Maven SpringBoot Web項目骨架

前言

最近很喜歡配置一些項目骨架，發現比以前真的是方便很多了。以前每次想寫個Demo都要先創建基本Maven項目，然後做一大堆的基礎配置，如：jar包依賴、數據庫連接配置、簡單日誌打印配置等等。
一次次的配置或者複製實在是太打擊激情了，所以通過配置項目骨架，直接一鍵就可以初始化好項目，直接寫代碼就好，我喜歡：)

對了，我之前就已經寫過一篇關於自定義Maven骨架的博客：《自定義Maven Hadoop項目骨架》，
所以這篇就簡單的說下關於Web配置的吧，其他的參考上篇。

項目依賴

這個項目依賴是指我們最終骨架中生成的依賴，而不是指骨架項目本身的依賴，這2者需要區分開來。
項目依賴pom.xml文件是放置在骨架項目 resources/archetype-resources/目錄下面的。我們需要骨架生成的東西都是放置resources目錄下

<?xml version="1.0" encoding="UTF-8"?>
<project 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.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>${groupId}</groupId>
    <artifactId>${artifactId}</artifactId>
    <version>${version}</version>

    <name>${artifactId}</name>

    <packaging>jar</packaging>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>


    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.2.0</version>
        </dependency>


        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

    </dependencies>


    <build>
        <finalName>${project.artifactId}</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-archetype-plugin</artifactId>
                <version>2.2</version>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <configuration>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.1</version>

                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <outputDirectory>${basedir}</outputDirectory>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

靜態資源文件

靜態資源文件是指包括.java代碼文件和配置文件，如：logback.xml日誌配置文件，application.properties應用配置文件，html、js等資源文件。
在上面的archetype-resources目錄下新建子目錄：src/main/java
然後在最裏面的java目錄下新建Application.java文件，內容如下：

package ${package};

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;


@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

不用多說，這個就是骨架最終會生成的文件。

然後是靜態資源文件，在src/main目錄下面新建一個resources目錄，
然後再在resources目錄下面添加：static、template目錄和application.properties、logback.xml文件。

這個完全是按照Springboot項目默認約定來的。下面分別說下它們的用途：

• static目錄用於放置html、js等文件;
• template用於放置freemarker等模板文件;
• application.properties主要是進行項目的配置，如：jdbc數據源鏈接、redis連接配置還有web相關的很多配置都可以寫在這裏面;
• logback.xml就是logback日誌輸出配置了。

骨架元數據

還有骨架元數據配置，這個就決定了最後骨架是如何生成的，以及生成包含哪些內容。
在骨架項目的resources目錄下面新建META-INF/maven目錄。注意這個META-INF目錄是與上面的archetype-resources目錄同一級的。
具體結構可參看之前那篇博客。
然後在maven目錄下，新建archetype-metadata.xml文件，內容如下：

<?xml version="1.0" encoding="UTF-8" ?>
<archetype-descriptor name="sample">
    <fileSets>
        <fileSet filtered="true" packaged="true">
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.java</include>
            </includes>
        </fileSet>

        <fileSet filtered="true" packaged="true">
            <directory>src/test/java</directory>

            <includes>
                <include>**/*.java</include>
            </includes>
        </fileSet>

        <fileSet filtered="true" packaged="false">
            <directory>src/main/resources</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
            </includes>
        </fileSet>

        <fileSet filtered="true" packaged="false">
            <directory>src/main/resources/static</directory>
        </fileSet>

        <fileSet filtered="true" packaged="false">
            <directory>src/main/resources/template</directory>
        </fileSet>

    </fileSets>

    <requiredProperties>
        <requiredProperty key="groupId">
            <defaultValue>com.infosys</defaultValue>
        </requiredProperty>
    </requiredProperties>
</archetype-descriptor>

編譯

好了，基本都配置完成。現在就是編譯，打包，應用了。
在骨架項目的根目錄下執行：

mvn archetype:create-from-project

生成骨架，然後再到target/generated-sources/archetype 目錄下，執行：

mvn clean install
mvn archetype:update-local-catalog

之後就可以在本地使用了。如果要上傳到私服的話，還需要額外的配置，然後再mvn deploy一下就好。具體參考上篇：《自定義Maven Hadoop項目骨架》。

最終結構如下：

│
└─src
    ├─main
    │  ├─java
    │  └─resources
    │      ├─archetype-resources
    │      │  │  pom.xml
    │      │  │
    │      │  └─src
    │      │      └─main
    │      │          ├─java
    │      │          │      Application.java
    │      │          │
    │      │          └─resources
    │      │              │  application.properties
    │      │              │  logback.xml
    │      │              │
    │      │              ├─static
    │      │              └─template
    │      └─META-INF
    │          └─maven
    │                  archetype-metadata.xml
    │
    └─test
        └─java