1.springcloud_多Maven工程项目建立(Finch

2019-02-23 本文已影响0人机智的jack

这是一个从零开始的springcloud的系列教程,如果你从中间开始看,可能会看不明白.请进入我的系列教程开始从头开始学习.spring-cloud教程

认识什么多Maven工程项目

多maven工程

有一个主工程,类型为pom类型.
主工程里的pom.xml配置了多个子工程.类型为jar或者war类型

如下图

主工程是springcloudlearn
配置了三个maven工程,分别是eureka-client,eureka-client2,eureka-server.

image.png

从零开始创建一个多maven工程项目

先创建一个maven工程, 我使用的ide是IDEA(也推荐大家使用IDEA,如果习惯使用eclipse也是可以).打开idea,选择Create New Project

image.png

左侧选择maven,点击右下脚的Next按钮

image.png

填写groupId为com.jack(可以随便写一个组织id,一般以域名倒序来做前缀)和artifactId为spring-cloud-learn(项目id),然后点击下一步.

image.png

确认工程名称和工程路径后,点击finish

image.png

得到工程结构如下, 典型的maven工程结构

image.png

spring-cloud-learn作为主工程,修改pom.xml里面内容, 设置工程为pom类型工程.

pom类型工程一般作为父级工程或者多maven工程的主工程

<?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>jack.com</groupId>
    <artifactId>spring-cloud-learn</artifactId>
    <version>1.0-SNAPSHOT</version>

    <!--设置maven工程类型为pom类型-->
    <packaging>pom</packaging>


    <properties>
        <!--
            maven项目会用maven-compiler-plugin默认的jdk版本来进行编译,
            下面两个参数是告诉maven编译器使用jdk版本，
        -->
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>


</project>

删除src文件夹,作为pom类型maven工程,不需要源代码和资源.

image.png

创建第一个子工程,eureka-server工程.右键点击spring-cloud-clearn文件夹.点击New->Module

image.png

groupId直接继承,填写artifactId为eureka-server.剩下的和之前创建maven工程一样.

image.png

创建完毕后,得到工程结构如下,主工程中含有一个子工程eureka-server.<u>该类型工程没有packaging标签.默认为jar类型maven工程</u>.

jar类型工程可以作为第三方库进行调用也可以当作主程序进行运行.打包出来是一个jar包

image.png

问题来了,那主工程怎么知道eureka-server是它的子工程呢?打开主工程的pom.xml,发现idea自动帮我写上了modules配置.可以看到modules标签,里面就配置了子工程的路径eureka-server.如果eureka-server在spring-cloud-learn工程/aaa文件夹下,则路径为aaa/eureka-server.

image.png

继承是让子类拥有父类的所有能力,maven中的工程继承概念也是如此.

为什么需要继承主工程的pom.xml呢?

因为很多pom.xml配置都是通用,比如主工程中pom.xml中properties标签,如果不继承,等于每个maven工程pom.xml都需要配置.

所以我们将eureka-server继承主工程的pom.xml.不过幸运的是,使用idea创建子工程,它会自动为我们做这件事.

打开eureka-server的pom.xml.parent标签表示父maven工程是谁,里面有三个元素.

artifactId: 父工程的项目id
groupId: 父工程的组织id
version: 父工程的版本号

image.png

依样画葫芦,创建eureka-client,eureka-client2,common,三个maven工程.得到工程目录结构为下图.

image.png

到这一步,一个多maven工程项目就建立完毕.接下来我们来尝试不同maven工程之间怎么相互调用

eureka-server调用common工程中的代码

给common工程创建一个Hello类,右键点击common工程下的java目录,New->Java Class

image.png

输入com.jack.common.Hello

image.png

得到

image.png

给Hello类写入代码

package com.jack;

public class Hello {
    public void sayHello() {
        System.out.println("Hello. I am Common module");
    }
}

eureka-server引入common工程.给eureka-server工程添加依赖.eureka-server工程中的pom.xml为

<?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">

    <!--继承主工程的pom.xml-->
    <parent>
        <artifactId>spring-cloud-learn</artifactId>
        <groupId>com.jack</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <modelVersion>4.0.0</modelVersion>

    <artifactId>eureka-server</artifactId>

    <dependencies>
        <!--引入common工程-->
        <dependency>
            <groupId>com.jack</groupId>
            <artifactId>common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

在eureka-server中进行使用common工程的Hello类

image.png

右键点击EurekaServerApplication,选中run

Screen Shot 2019-02-24 at 3.31.14 PM.png

运行成功,控制台打印出Hello. I am Common module

image.png

到这里eureka-server调用common的Hello类已经完毕,但是用一个问题,如果eureka-client也要引入common工程的话,表示eureka-client中的pom.xml也需要配置如下xml.

<dependencies>
        <!--引入common工程-->
        <dependency>
            <groupId>com.jack</groupId>
            <artifactId>common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

如果这个时候common版本号被更改了,也就表示我们要修改eureka-sevrer和eureka-client两个工程中的配置.如何避免这种情况呢?可以在主工程引入依赖管理,因为主工程是他们的父类,他们可以直接得到主工程配置的依赖管理信息.这种方法能保持项目各个工程依赖版本统一.

主工程的依赖管理

主工程的pom.xml,加所有子工程加入依赖管理中.

注意: 依赖管理(dependecyManagements)和依赖(dependices)不同.加入dependecyManagements中的依赖,只是声明了下我这个依赖的信息,其工程并没有权利使用这个依赖.加入depencies中的依赖,其工程直接将依赖引入,作为自己的第三方库使用.

主工程的pom.xml为

<?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>com.jack</groupId>
    <artifactId>spring-cloud-learn</artifactId>
    <version>1.0-SNAPSHOT</version>

    <!--主工程配置子工程的地方-->
    <modules>
        <module>eureka-server</module>
        <module>eureka-client</module>
        <module>eureka-client2</module>
        <module>common</module>
    </modules>

    <!--设置maven工程类型为pom类型-->
    <packaging>pom</packaging>

    <properties>
        <!--
            maven项目会用maven-compiler-plugin默认的jdk版本来进行编译,
            下面两个参数是告诉maven编译器使用jdk版本，
        -->
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>

        <default.version>1.0-SNAPSHOT</default.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <!--直接写版本号写法-->
            <!--<dependency>-->
                <!--<groupId>com.jack</groupId>-->
                <!--<artifactId>common</artifactId>-->
                <!--<version>1.0-SNAPSHOT</version>-->
            <!--</dependency>-->
            
            <!--使用property的写法-->
            <dependency>
                <groupId>com.jack</groupId>
                <artifactId>common</artifactId>
                <version>${default.version}</version>
            </dependency>

            <dependency>
                <groupId>com.jack</groupId>
                <artifactId>eureka-client</artifactId>
                <version>${default.version}</version>
            </dependency>

            <dependency>
                <groupId>com.jack</groupId>
                <artifactId>eureka-client2</artifactId>
                <version>${default.version}</version>
            </dependency>

            <dependency>
                <groupId>com.jack</groupId>
                <artifactId>eureka-server</artifactId>
                <version>${default.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

</project>

这个时候eureka-server中common的引入就可以去掉版本号.

<?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">

    <!--继承主工程的pom.xml-->
    <parent>
        <artifactId>spring-cloud-learn</artifactId>
        <groupId>com.jack</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <modelVersion>4.0.0</modelVersion>

    <artifactId>eureka-server</artifactId>

    <dependencies>
        <!--引入common工程-->
        <dependency>
            <groupId>com.jack</groupId>
            <artifactId>common</artifactId>
            <!--<version>1.0-SNAPSHOT</version>-->
        </dependency>
    </dependencies>
</project>

总结

现在我们做到了一个多工程的maven项目的建立.总结下一些知识点

maven常用的有三个类型的工程

pom类型:此类型工程一般作为父工程或者版本管理工程
war类型: 此类型工程打包成来的包,给j2ee规范http容器使用,比如tomcat,jetty等,依赖于容器才能运行
jar类型: 此类型打出来等包可以用作第三方库,也可以作为单独的程序进行运行

为什么要用多maven工程

高内聚:将相关代码放入一个工程中,容易维护
物理上减少耦合依赖:写代码都知道,要分层,避免相互依赖,依赖划分清晰.如果按照单工程的方式,纯粹靠人为规范来进行约束,是很难的.通过该方法可以在物理上避免大多数这种情况
易复用:比如底层通用代码写成一个工程,这样可以在不同的项目中进行引入使用
模块化:培养模块化思想至关重要

1.springcloud_多Maven工程项目建立(Finch

这是一个从零开始的springcloud的系列教程,如果你从中间开始看,可能会看不明白.请进入我的系列教程开始从头开始学习.spring-cloud教程

认识什么多Maven工程项目

从零开始创建一个多maven工程项目

eureka-server调用common工程中的代码

主工程的依赖管理

总结

猜你喜欢

热点阅读