2021SC@SDUSC 软件工程应用与实践——OpenMeetings项目分析（二）

2021SC@SDUSC

软件工程应用与实践——OpenMeetings项目分析（二）：

一、Maven介绍与使用

由于整个项目都和maven密不可分，因此先对maven做足够的了解并且分析其配置文件；

Maven ，是 Apache 下的一个纯 Java 开发的开源项目。基于项目对象模型（缩写：POM，因此maven的项目配置文件名字为pom.xml）概念，Maven利用一个中央信息片断能管理一个项目的构建、报告和文档等步骤。

Maven 是一个项目管理工具，可以对 Java 项目进行构建、依赖管理。

Maven 也可被用于构建和管理各种项目，例如 C#，Ruby，Scala 和其他语言编写的项目。Maven 曾是 Jakarta 项目的子项目，现为由 Apache 软件基金会主持的独立 Apache 项目。

Maven 提倡使用一个共同的标准目录结构，Maven 使用约定优于配置的原则，大家尽可能的遵守这样的目录结构。如下所示：

目录	目的
${basedir}	存放pom.xml和所有的子目录
${basedir}/src/main/java	项目的java源代码
${basedir}/src/main/resources	项目的资源，比如说property文件，springmvc.xml
${basedir}/src/test/java	项目的测试类，比如说Junit代码
${basedir}/src/test/resources	测试用的资源
${basedir}/src/main/webapp/WEB-INF	web应用文件目录，web项目的信息，比如存放web.xml、本地图片、jsp视图页面
${basedir}/target	打包输出目录
${basedir}/target/classes	编译输出目录
${basedir}/target/test-classes	测试编译输出目录
Test.java	Maven只会自动运行符合该命名规则的测试类
~/.m2/repository	Maven默认的本地仓库目录位置

Maven 特点:

• 项目设置遵循统一的规则。
• 任意工程中共享。
• 依赖管理包括自动更新。
• 一个庞大且不断增长的库。
• 可扩展，能够轻松编写 Java 或脚本语言的插件。
• 只需很少或不需要额外配置即可即时访问新功能。
• 基于模型的构建 − Maven能够将任意数量的项目构建到预定义的输出类型中，如 JAR，WAR 或基于项目元数据的分发，而不需要在大多数情况下执行任何脚本。
• 项目信息的一致性站点 − 使用与构建过程相同的元数据，Maven 能够生成一个网站或PDF，包括要添加的任何文档，并添加到关于项目开发状态的标准报告中。
• 发布管理和发布单独的输出 − Maven 将不需要额外的配置，就可以与源代码管理系统（如 Subversion 或 Git）集成，并可以基于某个标签管理项目的发布。它也可以将其发布到分发位置供其他项目使用。Maven 能够发布单独的输出，如 JAR，包含其他依赖和文档的归档，或者作为源代码发布。
• 向后兼容性 − 程序员可以很轻松的从旧版本 Maven 的多个模块移植到 Maven 3 中。
• 子项目使用父项目依赖时，正常情况子项目应该继承父项目依赖，无需使用版本号，
• 并行构建 − 编译的速度能普遍提高20 - 50 %。

如需使用maven,需要首先安装java,然后下载maven,去官网下载即可(官网;https://maven.apache.org/),然后配置环境变量:

配置如下配置：

• M2_HOME maven目录下的bin目录
• MAVEN_HOME maven的目录
• 在系统的path中配置 %MAVEN_HOME%\bin

测试Maven是否安装成功，保证必须配置完毕！

maven解压后的文件夹,conf是配置文件的位置,lib包含maven运行所包含的jar,maven-repo是自己新建文件夹,并设置为Maven的本地仓库,因为默认仓库在C盘;最好更改一下maven的镜像以加速下载,我用的是阿里云,正在conf下有个setting.xml文件,就是其配置文件,mirrors下新加mirror即可;

<mirror>
    <id>nexus-aliyun</id>  
    <mirrorOf>*,!jeecg,!jeecg-snapshots</mirrorOf>  
    <name>Nexus aliyun</name>  
    <url>http://maven.aliyun.com/nexus/content/groups/public</url> 
</mirror>

<localRepository>D:\Environment\apache-maven-3.6.2\maven-repo</localRepository>

在Idea里使用maven,可以在新建项目的时候选择上即可,同时idea提供了很多原型可供创建项目使用。创建好项目后，右边会出现maven的插件工具，即可对maven的各项基本功能方便的使用；

使用maven导入依赖，可以先去https://mvnrepository.com/这个maven远程仓库，搜索自己想要的依赖，然后复制相应的代码，粘贴在pom.xml里即可，maven便会自动帮你下载，同时在一次导入过后，再次使用时，idea会给与智能提示。

二、OpenMeetings项目中的web和webservice文件夹下maven的使用情况

两个pom.xml的头部都是相同的，在project标签内有三个属性：

<project xmlns="http://maven.apache.org/POM/4.0.0" <!--命名空间，类似包名，因为xml的标签可自定义，需要命名空间来区分-->
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"<!--xml遵循的标签规范-->
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
	http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <!--用来定义xmlschema的地址，也就是xml书写时需要遵循的语法，两部分组成，前面部分就是命名空间的名字，后面是xsd（xmlschema）的地址-->

下面是parent标签，描述各模块依赖关系，maven中，父模块导入依赖后，子模块无需再次导入；

<!--父项目的坐标。如果项目中没有规定某个元素的值，那么父项目中的对应值即为项目的默认值。 坐标包括group ID，artifact ID和 
        version。 -->
    <parent>
        <!--被继承的父项目的构件标识符 -->
        <artifactId />
        <!--被继承的父项目的全球唯一标识符 -->
        <groupId />
        <!--被继承的父项目的版本 -->
        <version />
        <!-- 父项目的pom.xml文件的相对路径。相对路径允许你选择一个不同的路径。默认值是../pom.xml。Maven首先在构建当前项目的地方寻找父项 
            目的pom，其次在文件系统的这个位置（relativePath位置），然后在本地仓库，最后在远程仓库寻找父项目的pom。 -->
        <relativePath />
    </parent>

<!--声明项目描述符遵循哪一个POM模型版本。模型本身的版本很少改变，虽然如此，但它仍然是必不可少的，这是为了当Maven引入了新的特性或者其他模型变更的时候，确保稳定性。 -->
    <modelVersion>4.0.0</modelVersion>
<!-- 构件的标识符，它和group ID一起唯一标识一个构件。换句话说，你不能有两个不同的项目拥有同样的artifact ID和groupID；在某个 
        特定的group ID下，artifact ID也必须是唯一的。构件是项目产生的或使用的一个东西，Maven为项目产生的构件包括：JARs，源 码，二进制发布和WARs等。 -->
	<artifactId>openmeetings-webservice</artifactId>
<!--项目的名称, Maven产生的文档用 -->
	<name>Openmeetings Webservices</name>
<!-- 项目的详细描述, Maven 产生的文档用。 当这个元素能够用HTML格式描述时（例如，CDATA中的文本会被解析器忽略，就可以包含HTML标 
        签）， 不鼓励使用纯文本描述。如果你需要修改产生的web站点的索引页面，你应该修改你自己的索引页文件，而不是调整这里的文档。 -->
	<description>Module for OpenMeetings CXF based web services.</description>
<!--项目产生的构件类型，例如jar、war、ear、pom。插件可以创建他们自己的构件类型，所以前面列的不是全部构件类型 -->
    <packaging>jar</packaging>

下面的build标签描述了构建此项目所需要的各类信息：

 <build>
        <!--使用的插件列表 -->
        <plugins>
            <!--参见build/pluginManagement/plugins/plugin元素 -->
            <plugin>
                <groupId />
                <artifactId />
                <version />
                <extensions />
                <executions>
                    <execution>
                        <id />
                        <phase />
                        <goals />
                        <inherited />
                        <configuration />
                    </execution>
                </executions>
                <dependencies>
                    <!--参见dependencies/dependency元素 -->
                    <dependency>
                        ......
                    </dependency>
                </dependencies>
                <goals />
                <inherited />
                <configuration />
            </plugin>
        </plugins>
    </build>

然后就是导入依赖所使用的dependencies标签：

 <!--这个元素描述了项目相关的所有依赖。 这些依赖组成了项目构建过程中的一个个环节。它们自动从项目定义的仓库中下载。-->
    <dependencies>
        <dependency>
            <!--依赖的group ID -->
            <groupId>org.apache.openmeetings</groupId>
            <!--依赖的artifact ID -->
            <artifactId>openmeetings-util</artifactId>
            <!--依赖的版本号。 在Maven 2里, 也可以配置成版本号的范围。 -->
            <version>${project.version}</version>
            <!-- 依赖类型，默认类型是jar。它通常表示依赖的文件的扩展名，但也有例外。一个类型可以被映射成另外一个扩展名或分类器。类型经常和使用的打包方式对应， 
                尽管这也有例外。一些类型的例子：jar，war，ejb-client和test-jar。如果设置extensions为 true，就可以在 plugin里定义新的类型。所以前面的类型的例子不完整。 -->
            <type>test-jar</type>
            <!--依赖范围。在项目发布过程中，帮助决定哪些构件被包括进来。欲知详情请参考依赖机制。 - compile ：默认范围，用于编译 - provided：类似于编译，但支持你期待jdk或者容器提供，类似于classpath 
                - runtime: 在执行时需要使用 - test: 用于test任务时使用 - system: 需要外在提供相应的元素。通过systemPath来取得 
                - systemPath: 仅用于范围为system。提供相应的路径 - optional: 当项目自身被依赖时，标注依赖是否传递。用于连续依赖时使用 -->
			<scope>test</scope>
        </dependency>
    </dependencies>