百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 博客教程 > 正文

Maven 干货: 简单两步,Maven Wrapper 接管你的Java项目编译!

connygpt 2024-11-12 10:09 19 浏览

Maven 是Java项目中非常重要的构建工具,在所有的Java项目构建工具中占比靠前,其功能完备,成熟稳定。

但是,和所有的构建工具一样,因为版本或者主要配置在不同环境下的差异,导致项目无法编译运行的事实不可回避。

那么,有什么好点的办法来尽可能地规避这一问题呢? 除了了团队管理上的要求之外,适当地使用工具不失为更理想的方式。

那么今天,我们来再认识一下: Maven Wrapper

一. Maven Wrapper 是什么?

  • Maven Wrapper 主要是随项目本身携带Maven版本和脚本,以保证项目的Maven运行环境保持统一.
  • Maven Wrapper 特性:
  1. 独立于系统环境: 使用 Maven Wrapper ,它可以确保当前项目独立于系统环境,使用指定的版本的Maven。甚至于可以指定使用定制化的Maven运行时。
  2. 自安装 Maven: 当项目初次编译时,Maven Wrapper 会自动下载指定的 Maven 版本。这样的方式相比新环境或新人员必须先预装好Maven,配置好环境来说,相对更友好。
  3. 项目内一致性: 将Maven Wrapper相关内容和项目源码一起加入版本管理,可以保证所有参与当前项目的使用统一的Maven 版本,避免因编译版本的差异导致的一系列问题。
  4. 对CI/CD友好: Maven Wrapper的运行可以直接使用mvnw/mvnw.cmd命令,这样在CI/CD流水线中可以直接预设好命令执行操作,而不用担心环境中是否有正确的Maven配置。
  5. 主流IDE支持: 像Java开发者常用的编辑器: IDEA,当项目中有Maven Wrapper的时候,默认就会自动选择Maven Wrapper作编译运行时.

二. 初步认识

那么,项目中要怎么引入并使用Maven Wrapper呢?

这里有个悖论,Maven Wrapper是为了保证Maven使用的统一性,但是初始化Maven Wrapper确实又依赖Maven 环境.

目前只发现下面两种标准的初始化Maven Wrapper的方式(人肉Copy除外)

1. 使用Maven 插件初始化

Maven环境中默认预装的有 Maven Wrapper Plugin 插件.

- 一个Maven 项目初始化后,其结构大致如下:

|   pom.xml
|   
\---src
    +---main
    |   +---java
    |   |                   
    |   \---resources
    \---test
        \---java

- 在项目根目录下执行mvn wrapper:wrapper [-Dmaven=3.x.x]命令

等待命令执行完成后,项目结构就会变成大致如下模样:

|   mvnw
|   mvnw.cmd
|   pom.xml
| 
+---.mvn
|   \---wrapper
|           maven-wrapper.jar
|           maven-wrapper.properties  
\---src
    +---main
    |   +---java
    |   |                   
    |   \---resources
    \---test
        \---java

- 上述结构说明

  • ./mvnw./mvnw.cmd 分别是Unix系统和Windows系统对应的命令脚本.
  • ./.mvn 目录是标准的Maven扩展配置目录,其中的wrapper中存放Maven Wrapper基本的信息.
  • ./.mvn/wrapper/maven-wrapper.jar 这个简单的Java包主要提供Maven环境的下载和初始化.
  • ./.mvn/wrapper/maven-wrapper.properties 这个文件里是maven-wrapper.jar 执行时的主要配置参数.

- maven-wrapper.properties配置说明

  • wrapperUrl 这个地址是下载wrapper.jar的地址

默认的是maven官方的下载地址.但是因为众所周知的原因,这个地址下载一般不会太快。

所以可以把jar包放在自己的Maven私库或其它地址.然后修改这里的地址为自己的地址,这样在其它人使用时也会获得较快的初始化速度.

  • distributionUrl 这个地址是下载对应版本的Maven压缩包zip文件的地址

同样的道理,我们也可以将zip文件上传我们自己的地址上,然后修改配置.

- 脚本定制

Maven Wrapper在运行时支持一些环境变量和命令行变量的注入,但是如果说这些变量完全由执行时加入,就感觉有点违背Maven Wrapper本身的作用,索性直接进行脚本定制来得实际些.

进行脚本定制也不能无脑定制,最好就是只定义这几个特殊环境变量的值来达到效果,如果脚本改动太多,后期的升级维护也是个麻烦.

  • MVNW_VERBOSE 这个就不细说了,都猜得到》。。
  • MVNW_USERNAME , MVNW_PASSWORD

这两个变量主要是在访问 distributionUrl 时进行 Basic Authentication 鉴权.
也可以直接在
distributionUrl 上配置上直接配置 Basic信息:

distributionUrl=https://username:password@<yourserver>/maven2/org/apache/maven/apache-maven/3.x.x/apache-maven-3.x.x-bin.zip
  • MAVEN_USER_HOME
    这个变量主要是指定 Maven Wrapper进行实际的Maven安装的地址,

默认的地址是: $用户目录/.m2/

  • MVNW_REPOURL
    看到
    REPOURL可能就已经猜得到了,

这个变量是用于maven-wrapper.properties中两个URL的根地址部分.

  • MAVEN_CONFIG
    为Maven运行时添加运行参数.
  • 定制脚本结果:
    (以
    mvnw.cmd 为例)
@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
@echo off
set MAVEN_USER_HOME=./.mvn/m2/
set MVNW_REPOURL=https://repo.maven.apache.org
set MAVEN_CONFIG=-s ./.mvn/settings.xml -T4 -Dfile.encoding=UTF-8
@REM set title of command window
title %0
# ...... 其余省略.
  • 使用mvnw.cmd编译项目
.\mvnw.cmd clean install
# 会先判断当前环境,如果尚未执行Maven安装,会先执行Maven下载和安装.
Found "G:\test\demo\.mvn\wrapper\maven-wrapper.jar"
[INFO] Apache Maven Wrapper 3.2.0
# ......

2. Spring Initializr创建项目并初始化

如果有在使用 Spring Initializr 创建项目的,可能都有注意到,在选择Maven创建后,

项目结构大致如下:

|   .gitignore
|   HELP.md
|   mvnw
|   mvnw.cmd
|   pom.xml   
+---.mvn
|   \---wrapper
|           maven-wrapper.jar
|           maven-wrapper.properties
\---src
    +---main
    |   +---java
    |   \---resources
    |           application.properties
    |           
    \---test
        \---java

默认都是使用的Maven Wrapper,比使用插件还省心一些.
但是其本质还是使用的wrapper插件进行的相关初始化。

3. 自定义项目脚手架初始化

这里主要指Maven Archetypes,这个就是Maven脚手架加上人肉Copy了,这里只提供方式参考,就不展开了。

- 附上 Mavaen Wrapper Plugin支持的参数列表

目前最新的版本为:
org.apache.maven.plugins:maven-wrapper-plugin:3.2.0:wrapper

参数说明:

名称

类型

初始版本

描述

<alwaysDownload>

boolean

3.2.0

Determines if the Maven distribution should be downloaded on every execution of the Maven wrapper.
Default value is: false.
User property is: alwaysDownload.

<distributionSha256Sum>

String

3.2.0

The expected SHA-256 checksum of the Maven distribution that is executed by the installed wrapper.
User property is: distributionSha256Sum.

<distributionType>

String

3.0.0

Options are:
script
only mvnw scripts
bin (default)
precompiled and packaged code
source
Java source code, will be compiled on the fly
only-script
the new lite implementation of mvnw/mvnw.cmd scripts downloads the maven directly and skips maven-wrapper.jar - since 3.2.0
Value will be used as classifier of the downloaded file
Default value is: bin.
User property is: type.

<includeDebugScript>

boolean

3.0.0

Include mvnwDebug* scripts?
Default value is: false.
User property is: includeDebug.

<mavenVersion>

String

3.0.0

The version of Maven to require, default value is the Runtime version of Maven. Can be any valid release above 2.0.9
User property is: maven.

<mvndVersion>

String

3.2.0

The version of Maven Daemon to require.
User property is: mvnd.

<wrapperSha256Sum>

String

3.2.0

The expected SHA-256 checksum of the maven-wrapper.jar that is used to load the configured Maven distribution.
User property is: wrapperSha256Sum.

三. 感悟

工具是死的,人是活的,活学活用,解决实际问题!

总有人说,Gradle比Maven各种好用,自己去体验后,却是一言难尽。

相信这篇文章,能对一部分朋友有所裨益,更多Java知识,Spring Boot知识,实用干货推荐,点击关注,持续更新!

了解Java最新知识:Java不知不觉已经这么强大了,快来了解新特性,不然要落伍了!

相关推荐

3分钟让你的项目支持AI问答模块,完全开源!

hello,大家好,我是徐小夕。之前和大家分享了很多可视化,零代码和前端工程化的最佳实践,今天继续分享一下最近开源的Next-Admin的最新更新。最近对这个项目做了一些优化,并集成了大家比较关注...

干货|程序员的副业挂,12个平台分享

1、D2adminD2Admin是一个完全开源免费的企业中后台产品前端集成方案,使用最新的前端技术栈,小于60kb的本地首屏js加载,已经做好大部分项目前期准备工作,并且带有大量示例代码,助...

Github标星超200K,这10个可视化面板你知道几个

在Github上有很多开源免费的后台控制面板可以选择,但是哪些才是最好、最受欢迎的可视化控制面板呢?今天就和大家推荐Github上10个好看又流行的可视化面板:1.AdminLTEAdminLTE是...

开箱即用的炫酷中后台前端开源框架第二篇

#头条创作挑战赛#1、SoybeanAdmin(1)介绍:SoybeanAdmin是一个基于Vue3、Vite3、TypeScript、NaiveUI、Pinia和UnoCSS的清新优...

搭建React+AntDeign的开发环境和框架

搭建React+AntDeign的开发环境和框架随着前端技术的不断发展,React和AntDesign已经成为越来越多Web应用程序的首选开发框架。React是一个用于构建用户界面的JavaScrip...

基于.NET 5实现的开源通用权限管理平台

??大家好,我是为广大程序员兄弟操碎了心的小编,每天推荐一个小工具/源码,装满你的收藏夹,每天分享一个小技巧,让你轻松节省开发效率,实现不加班不熬夜不掉头发,是我的目标!??今天小编推荐一款基于.NE...

StreamPark - 大数据流计算引擎

使用Docker完成StreamPark的部署??1.基于h2和docker-compose进行StreamPark部署wgethttps://raw.githubusercontent.com/a...

教你使用UmiJS框架开发React

1、什么是Umi.js?umi,中文可发音为乌米,是一个可插拔的企业级react应用框架。你可以将它简单地理解为一个专注性能的类next.js前端框架,并通过约定、自动生成和解析代码等方式来辅助...

简单在线流程图工具在用例设计中的运用

敏捷模式下,测试团队的用例逐渐简化以适应快速的发版节奏,大家很早就开始运用思维导图工具比如xmind来编写测试方法、测试点。如今不少已经不少利用开源的思维导图组件(如百度脑图...)来构建测试测试...

【开源分享】神奇的大数据实时平台框架,让Flink&amp;Spark开发更简单

这是一个神奇的框架,让Flink|Spark开发更简单,一站式大数据实时平台!他就是StreamX!什么是StreamX大数据技术如今发展的如火如荼,已经呈现百花齐放欣欣向荣的景象,实时处理流域...

聊聊规则引擎的调研及实现全过程

摘要本期主要以规则引擎业务实现为例,陈述在陌生业务前如何进行业务深入、调研、技术选型、设计及实现全过程分析,如果你对规则引擎不感冒、也可以从中了解一些抽象实现过程。诉求从硬件采集到的数据提供的形式多种...

【开源推荐】Diboot 2.0.5 发布,自动化开发助理

一、前言Diboot2.0.5版本已于近日发布,在此次发布中,我们新增了file-starter组件,完善了iam-starter组件,对core核心进行了相关优化,让devtools也支持对IAM...

微软推出Copilot Actions,使用人工智能自动执行重复性任务

IT之家11月19日消息,微软在今天举办的Ignite大会上宣布了一系列新功能,旨在进一步提升Microsoft365Copilot的智能化水平。其中最引人注目的是Copilot...

Electron 使用Selenium和WebDriver

本节我们来学习如何在Electron下使用Selenium和WebDriver。SeleniumSelenium是ThoughtWorks提供的一个强大的基于浏览器的开源自动化测试工具...

Quick &#39;n Easy Web Builder 11.1.0设计和构建功能齐全的网页的工具

一个实用而有效的应用程序,能够让您轻松构建、创建和设计个人的HTML网站。Quick'nEasyWebBuilder是一款全面且轻巧的软件,为用户提供了一种简单的方式来创建、编辑...