Maven开发规范

最新推荐文章于 2022-11-04 17:02:46 发布
最新推荐文章于 2022-11-04 17:02:46 发布
阅读量917 收藏 1
点赞数 1
分类专栏： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_15103197/article/details/82876886
版权

大家好，我是瓜哥:

  最近在做微服务项目架构搭建，maven是我们开发当中必不可少的工具，下面对maven的一些规范进行整理。

  • Maven目录结构说明

src/main/java

源代码目录

src/main/resources

所需资源目录

src/main/filters

资源过滤文件目录

src/main/assembly

Assembly descriptors

src/main/config

配置文件根目录

src/main/webapps

各种静态资源或者web相关资源

src/test/java

测试代码目录

src/test/resources

测试所需资源目录

src/test/filters

测试资源过滤文件目录

src/site

与site相关的资源目录

Target/

输出目录根

Target/classes

项目主体输出目录

Test-classes

项目测试输出目录

LICENSE.txt

Project's license

README.txt

Project's readme

  • Maven聚合工程项目结构规范

如下为maven聚合工程的一个项目结构

maven-project(Maven Project)
  |- maven-sub1(Maven Module)
  |- maven-sub2
  |- maven-sub3

|- maven-sub4

maven-project就是个建一个普通的Maven Project，这里省略。唯一注意的一点是，Packaging必须选择pom。

1、要在pom工程中定义公共变量

<!-- 定义公共变量 --> 

<properties> 

       <maven.compiler.source>1.8</maven.compiler.source>

       <maven.compiler.target>1.8</maven.compiler.target>

       <maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion>

       <junit.version>4.12</junit.version>

</properties>   

2、pom工程中定义聚合模块

<!-- 待聚合模块 --> 

<modules>

     <module>study-common</module>

     <module>study-pojo</module>

     <module>study-dao</module>

     <module>study-service</module>

     <module>study-elasticsearch</module>

     <module>study-zookeeper</module>

     <module>study-web</module>

</modules>

3、pom工程中配置远程部署仓库地址

<!-- 配置部署的远程仓库 --> 

<distributionManagement>

            <repository>

                  <id>spdbccc</id>

                  <name>Nexus deppen</name>

                  <url>http://192.168.17.183:8081/nexus/content/repositories/releases</url>

            </repository>

            <snapshotRepository>

                  <id>snapshot</id>

                  <name>Repository for pamirs</name>

                  <url>http://192.168.17.183:8081/nexus/content/repositories/snapshots</url>

            </snapshotRepository>

</distributionManagement>

 

4、<dependencyManagement/>元素中引入所有要进入的jar包

a、这里配置了<distributionManagement>，这样子项目就不需要重复配置了  
b、通过<pluginManagement>，对一些插件进行了公共的配置，这里主要是为了消除构建时的告警  

  • pom工程规范举例

<?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.study</groupId>

           <artifactId>study</artifactId>

           <version>0.0.1-SNAPSHOT</version>

           <packaging>pom</packaging>

 

           <name>study</name>

           <url>http://www.example.com</url>

 

           <properties>

                      <project.build.sourceEncoding>utf-8</project.build.sourceEncoding>

                      <jdk.version>1.8</jdk.version>

                      <maven.compiler.source>1.8</maven.compiler.source>

                      <maven.compiler.target>1.8</maven.compiler.target>

                      <maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion>

                      <junit.version>4.12</junit.version>

                      <servlet.version>3.0.1</servlet.version>

                      <jsp-api.version>2.0</jsp-api.version>

                      <jstl.version>1.2</jstl.version>

                      <log4j2.version>2.8.2</log4j2.version>

                      <spring.version>4.3.8.RELEASE</spring.version>

                      <mybaitsplus.version>2.0.8</mybaitsplus.version>

                      <mysql.version>5.1.40</mysql.version>

                      <druid.version>1.0.29</druid.version>

                      <shiro.version>1.3.2</shiro.version>

                      <ehcache.version>2.6.11</ehcache.version>

                      <jackson.version>2.8.8</jackson.version>

                      <commons-io.version>2.5</commons-io.version>

                      <hibernate-validator.version>5.3.5.Final</hibernate-validator.version>

                      <poi.version>3.16</poi.version>

                      <jetty.version>9.2.17.v20160517</jetty.version>

                      <commons-lang3.version>3.6</commons-lang3.version>

                      <el-api.version>2.2</el-api.version>

                      <el.version>3.0.0</el.version>

                      <hibernate-validator.version>5.1.3.Final</hibernate-validator.version>

           </properties>

           <modules>

                      <module>study-common</module>

                      <module>study-pojo</module>

                      <module>study-dao</module>

                      <module>study-service</module>

                      <module>study-elasticsearch</module>

                      <module>study-zookeeper</module>

                      <module>study-web</module>

           </modules>

           <dependencyManagement>

                      <dependencies>

                                 <!-- test begin -->

                                 <dependency>

                                            <groupId>junit</groupId>

                                            <artifactId>junit</artifactId>

                                            <version>${junit.version}</version>

                                 </dependency>

                                 <!-- web begin -->

                                 <dependency>

                                            <groupId>javax.servlet</groupId>

                                            <artifactId>javax.servlet-api</artifactId>

                                            <version>${servlet.version}</version>

                                            <scope>provided</scope>

                                 </dependency>

                                 <dependency>

                                            <groupId>javax.servlet</groupId>

                                            <artifactId>jsp-api</artifactId>

                                            <version>${jsp-api.version}</version>

                                            <scope>provided</scope>

                                 </dependency>

                                 <dependency>

                                            <groupId>javax.servlet</groupId>

                                            <artifactId>jstl</artifactId>

                                            <version>${jstl.version}</version>

                                 </dependency>

                                 <!-- web end -->

                                 <!-- log4j2 begin -->

                                 <dependency>

                                            <groupId>org.apache.logging.log4j</groupId>

                                            <artifactId>log4j-core</artifactId>

                                            <version>${log4j2.version}</version>

                                 </dependency>

                                 <dependency>

                                            <groupId>org.apache.logging.log4j</groupId>

                                            <artifactId>log4j-jcl</artifactId>

                                            <version>${log4j2.version}</version>

                                 </dependency>

                                 <dependency>

                                            <groupId>org.apache.logging.log4j</groupId>

                                            <artifactId>log4j-slf4j-impl</artifactId>

                                            <version>${log4j2.version}</version>

                                 </dependency>

                                 <!-- log4j2 end -->

                                 <!-- Spring begin -->

                                 <dependency>

                                            <groupId>org.springframework</groupId>

                                            <artifactId>spring-test</artifactId>

                                            <version>${spring.version}</version>

                                            <scope>test</scope>

                                 </dependency>

                                 <dependency>

                                            <groupId>org.springframework</groupId>

                                            <artifactId>spring-webmvc</artifactId>

                                            <version>${spring.version}</version>

                                 </dependency>

                                 <dependency>

                                            <groupId>org.springframework</groupId>

                                            <artifactId>spring-jdbc</artifactId>

                                            <version>${spring.version}</version>

                                 </dependency>

                                 <dependency>

                                            <groupId>org.springframework</groupId>

                                            <artifactId>spring-aspects</artifactId>

                                            <version>${spring.version}</version>

                                 </dependency>

                                 <dependency>

                                            <groupId>org.springframework</groupId>

                                            <artifactId>spring-context-support</artifactId>

                                            <version>${spring.version}</version>

                                 </dependency>

                                 <!-- spring end -->

                                 <dependency>

                                            <groupId>commons-io</groupId>

                                            <artifactId>commons-io</artifactId>

                                            <version>${commons-io.version}</version>

                                 </dependency>

 

                                 <!-- jackson begin -->

                                 <dependency>

                                            <groupId>com.fasterxml.jackson.core</groupId>

                                            <artifactId>jackson-databind</artifactId>

                                            <version>${jackson.version}</version>

                                 </dependency>

                                 <!-- jackson end -->

                                 <!-- shiro begin -->

                                 <dependency>

                                            <groupId>org.apache.shiro</groupId>

                                            <artifactId>shiro-spring</artifactId>

                                            <version>${shiro.version}</version>

                                            <exclusions>

                                                       <exclusion>

                                                                  <artifactId>slf4j-api</artifactId>

                                                                 <groupId>org.slf4j</groupId>

                                                       </exclusion>

                                            </exclusions>

                                 </dependency>

                                 <!-- poi provided 不强制依赖 -->

                                 <dependency>

                                            <groupId>org.apache.poi</groupId>

                                            <artifactId>poi-ooxml</artifactId>

                                            <version>${poi.version}</version>

                                            <scope>provided</scope>

                                 </dependency>

                                 <!-- ehcache和redis必选其一，也可同时使用（需要注意） -->

                                 <dependency>

                                            <groupId>net.sf.ehcache</groupId>

                                            <artifactId>ehcache-core</artifactId>

                                            <version>${ehcache.version}</version>

                                 </dependency>

 

                                 <dependency>

                                            <groupId>org.glassfish</groupId>

                                            <artifactId>javax.el</artifactId>

                                            <version>${el.version}</version>

                                 </dependency>

                                 <dependency>

                                            <groupId>javax.el</groupId>

                                            <artifactId>el-api</artifactId>

                                            <version>${el-api.version}</version>

                                 </dependency>

                                 <dependency>

                                            <groupId>org.apache.commons</groupId>

                                            <artifactId>commons-lang3</artifactId>

                                            <version>${commons-lang3.version}</version>

                                 </dependency>

                                 <!-- Mybatis-Plus -->

                                 <dependency>

                                            <groupId>com.baomidou</groupId>

                                            <artifactId>mybatis-plus</artifactId>

                                            <version>${mybaitsplus.version}</version>

                                 </dependency>

                                 <dependency>

                                            <groupId>mysql</groupId>

                                            <artifactId>mysql-connector-java</artifactId>

                                            <version>${mysql.version}</version>

                                 </dependency>

                                 <dependency>

                                            <groupId>com.alibaba</groupId>

                                            <artifactId>druid</artifactId>

                                            <version>${druid.version}</version>

                                 </dependency>

                                 <dependency>

                                            <groupId>org.hibernate</groupId>

                                            <artifactId>hibernate-validator</artifactId>

                                            <version>${hibernate-validator.version}</version>

                                            <!-- <classifier>testing</classifier> -->

                                 </dependency>

                      </dependencies>

           </dependencyManagement>

           <!-- 使用aliyun镜像 -->

           <repositories>

                      <repository>

                                 <id>aliyun</id>

                                 <name>aliyun</name>

                                 <url>http://maven.aliyun.com/nexus/content/groups/public</url>

                      </repository>

           </repositories>

</project>

 

  • Maven常用插件总结

<build>

            <finalName>study-common</finalName>

            <plugins>

                  <plugin>

                       <groupId>org.apache.maven.plugins</groupId>

                       <artifactId>maven-compiler-plugin</artifactId>

                       <version>2.3.2</version>

                       <configuration>

                             <source>${jdk.version}</source>

                             <target>${jdk.version}</target>

                             <encoding>${project.build.sourceEncoding}</encoding>

                       </configuration>

                  </plugin>

                  <plugin>

                       <groupId>org.apache.maven.plugins</groupId>

                       <artifactId>maven-surefire-plugin</artifactId>

                       <version>2.12.4</version>

                       <configuration>

                             <excludes>

                                   <exclude>**/*Test.java</exclude>

                             </excludes>

                       </configuration>

                  </plugin>

                  <plugin>

                       <groupId>org.apache.maven.plugins</groupId>

                       <artifactId>maven-jar-plugin</artifactId>

                       <version>3.0.2</version>

                  </plugin>

<!-- 自动在运行的时候进行打成war包 -->

                  <plugin>

                       <groupId>org.apache.maven.plugins</groupId>

                       <artifactId>maven-war-plugin</artifactId>

                       <version>2.1.1</version>

                       <configuration>

                             <!-- 重点是这个配置 -->

                             <warName>cubc</warName>

                             <warSourceDirectory>${project.basedir}/${pro.outerDirectory}</warSourceDirectory>

                             <packagingExcludes>WEB-INF/web.xml</packagingExcludes>

                             <failOnMissingWebXml>false</failOnMissingWebXml>

                                                <warSourceExcludes>js/**/*.js,libs/**/*.js,css/**/*.css,libs/**/*.css,WEB-INF/**/*.html</warSourceExcludes>

                       </configuration>

                  </plugin>

            </plugins>

      </build>

 

IT瓜哥-杨得朝
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Maven2使用项目开发规范说明.doc
05-09
《Maven2使用项目开发规范说明》，图文并茂，详细介绍了使用 Maven2 开发一个规范项目的流程。 目录： 1. 环境配置 3 1.1. 配置Maven2 3 1.2. 配置Eclipse环境变量MIA_LIB 4 1.3. 安装Maven2 的eclipse plugin 4 2. Maven2使用说明 5 2.1. 简单例子 5 2.2. groupId, artifactId, version的作用 7 2.3. Maven2的plugin, goal和phase的说明 8 2.3.1. plugin和goal 8 2.3.2. phase 9 2.3.3. plugin goal与phase的区别 10 2.3.4. 命令行一次执行多个 goal或phase 12 2.4. 几个常用的phase: clean, compile, package, install 12 2.5. 工程依赖jar包的设置 13 2.5.1. 设置说明 13 2.5.2. 关于maven2资源库 15 2.6. 手动安装jar包到本地资源库 16 2.7. 使用maven编译项目代码注意事项 17 3. 构建项目规范说明 18 3.1. 项目目录结构 18 3.2. 设置groupId, artifactId规范 20 3.3. 在Eclipse要引用的jar包设置规范 20 3.4. MIA_LIB维护更新规范 22 4. 参考资料链接 23
maven使用说明
风中浮柳的专栏
01-16 631
到官网上下载maven  ： http://maven.apache.org/download.cgi 我下载的是 3.50版本，如果想更深入的了解，请查看官方帮助文档 http://maven.apache.org/guides/getting-started/index.html 1.安装maven   安装maven的时候需要确保当前电脑要有jdk环境。   把下载的 apa
4、Maven规约
清云逸仙的博客
03-11 547
文件状态： [ ] 草稿 [√] 正在修改 当前版本 1.0 历史修订版本 1.0; 作 者 杜有龙 完成日期 2019-09-18 什么是Maven项目规约？其实就是maven项目的目录结构。 一、结构图 二、解释 maven项目的目录结构遵守以下规范 ...
【Maven】Maven项目的标准目录
王晓斌的专栏
08-19 3964
在Maven中，任何一个依赖，插件或者项目构建的输出，都可以成为构件。 得益于坐标机制，任何Mavenxiang'm
Maven项目构建规范
dengzhaomu0576的博客
09-18 306
一、dependencyManagement 　　1. Framework相关jar包，统一父pom版本号，内部Module相互之间的应用，都引用${project.2.version}，子Module不设置version，集成父pom的版本号，发版framework统一发版本。 　　2. 通过增加pommgmt项目单独管理第三方依赖包的管理，海鼎内部的jar...
Maven多模块版本规范
Susan8888的专栏
02-27 8582
背景 无论是支付端还是金融端的Java项目，大部分都是多模块的Maven项目，同一项目下的不同模块版本比较混乱，发布到Maven私服里的Jar包版本也很混乱，本规范目的是要统一Jar包版本规范。 规范 1、同一项目中所有模块版本保持一致 2、子模块统一继承父模块的版本 3、统一在顶层模块Pom的节中定义所有子模块的依赖版本号，子模块中添加依赖时不要添加版本号 4
maven开发会议项目
08-01
在本项目中，"maven开发会议项目"是一个基于Java编程语言并利用Maven构建工具进行开发的会议管理系统。这个系统旨在实现会议记录的登记、查询以及其他相关功能，是大四实训项目的一部分，旨在帮助学生深入理解和应用...
JAVA开发规范手册1.50
05-20
JAVA开发规范手册1.50 本手册是阿里巴巴集团技术团队的集体智慧结晶和经验总结，旨在提高Java开发者的综合素质和软件开发质量。手册共分七个维度：编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构...
Maven 3.5.0版本资源
最新发布
06-11
Maven 是一个Java项目管理和综合工具，由Apache软件基金会开发。它简化了构建、依赖管理和项目信息管理的过程。Maven 使用一种标准的项目对象模型（Project Object Model，POM），通过POM文件来描述项目的配置信息，...
maven历史版本下载
06-18
**正文** Maven是Java开发领域中...通过使用Maven，项目构建过程可以更加规范化和自动化，大大提升了开发效率。因此，无论是初学者还是经验丰富的开发者，都应该掌握Maven的使用技巧，以适应快速变化的软件开发环境。
maven开发文档和案例
06-24
总的来说，Maven是Java开发中不可或缺的工具，它通过规范化的项目管理和构建方式，极大地提升了开发效率和项目的可维护性。通过深入理解Maven的核心概念和使用方法，开发者能够更好地利用它来构建复杂的应用程序。
MAVEN项目标准目录结构
热门推荐
lengyue的专栏
08-25 13万+
1.标准目录结构： src   -main       –bin 脚本库       –java java源代码文件       –resources 资源库，会自动复制到classes目录里       –filters 资源过滤文件       –ass
关于maven的项目结构，目录规范
Angus
10-07 917
   我们在创建meven项目的时候，最好是遵循目录规范，这样自己可以少遭点罪，因为不按照这个来，是很有可能出来一大堆的莫名奇妙的错误，都需要浪费大把的时间来解决。   ...
maven-assembly-plugin
u011250186的博客
11-04 1315
maven-assembly-plugin
使用maven搭建多模块项目
北有风雪
02-06 1万+
我们为什么要进行模块化开发？在多人使用Maven协作开发项目时，尤其是稍微上点规模的项目，每个RD的工作都细分到具体功能和模块，有些模块甚至还要单独部署。我们假设有这样一个商城项目，包括以下几个模块： - 商城前台（shop） - 管理后台（admin） - 数据库交互模块（dao） - 通用业务模块（service） - 接口模块（api） - 通用工具（util）其中shop和adm
#最详细的开发一个完整的maven项目，使其实现基本注册功能（笔记，只用）
小肚
03-20 531
首先，基于我上一篇maven文章中已经搭建好的maven包，那么如何具体编程使其实现登录注册等功能呢？ 如下！ 如此，是因为jsp页面的代码太多，我单独将js代码拎出来创一个文件，如此可以更清晰的编程！！ 如此，就完成啦！！！！！！ ...
Maven变量及常见插件配置详解
amorym的专栏
09-22 1万+
一、变量-自定义变量及内置变量 1.自定义变量 tools UTF-8 2.内置变量 ${basedir} 项目根目录 ${project.build.directory} 构建目录，缺省为target ${project.build.outputDirectory} 构建过程输出目录
Maven项目deployment Descriptor 不出现总结几种情况
qq_42465381的博客
04-28 595
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。 本文链接：https://blog.csdn.net/qq_40203552/article/details/103420090 第一种： 视图问题，如下图所示，在窗口右上角选择JavaEE，比如：java是不出现的 这是比较常见的问题 第二种： 资源没有更新出来，通过Maven update更新显示，如图： 选择项目，右键，找到Maven，子菜单update project，选中，
maven开发web项目
Adolph的专栏
07-15 7062
初步接受maven项目，创建maven项目1、选择新建，选择maven project2、选择workspace路径3、选择项目类型，一般用到的就两种，java项目和web项目java项目web项目4、建好之后，可能会少几个目录资源目录，可以新建5、修改jdk版本，配置pom文件本地jar包可以安装到本地仓库repository,然后就可以直接引用（像引用中央仓库一样），版本可以随便定6、配置to...
Maven实战.pdf
03-30
Archetype插件能够帮助开发者快速创建Maven项目，提高项目的开发效率。Maven的插件机制能够帮助开发者扩展Maven的功能，满足项目的特殊需求。 《Maven实战》适合所有Java程序员阅读，无论你是从未使用过Maven，亦...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

IT瓜哥-杨得朝

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值