使用 Maven Embedder 通过代码执行 maven 命令

码农张思壮 2020-11-07 20:56:02
代码 maven 使用 执行 embedder


如果有个需求是要通过代码调用 maven 命令,来上传 jar 包或进行其他操作,该如何实现?

调用命令行当然可以,maven 官方也有一个项目 Apache Maven Invoker 实现类似需求,但前提是服务运行的机器或者容器中需要有 maven。

大家可能都听说过 Write once, run anywhere. 如果没了 maven 环境就执行不了了,有没有更好的方式呢

Maven Embedder 也是 maven 官方的一个项目,如名字一样,是可嵌入的,也就是不需要依赖外部 maven。项目是个好项目,但问题就是官方提供的文档实在太少了。

以防被喷,这里没有说嵌入一定是更好的方案,毕竟不可能把项目所需的所有依赖都打包到一起,还是要根据实际问题来选择的。

依赖

按照官方其实只需要 maven-embedder 一个依赖就可以,但实际运行起来,会发现报很多错,这里也不啰嗦,直接放出完整可用的依赖。

<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-embedder</artifactId>
<version>3.6.3</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-compat</artifactId>
<version>3.6.3</version>
</dependency>
<dependency>
<groupId>org.apache.maven.resolver</groupId>
<artifactId>maven-resolver-connector-basic</artifactId>
<version>1.4.1</version>
</dependency>
<dependency>
<groupId>org.apache.maven.resolver</groupId>
<artifactId>maven-resolver-transport-http</artifactId>
<version>1.4.1</version>
</dependency>

maven-compat 是一个用于保持与 Maven2 兼容性的包。

maven-resolver-connector-basicmaven-resolver-transport-http 用于 deploy。如果只运行到 install,不需要 deploy ,这两个依赖可以去掉。网上很多会用 aether 项目中的依赖,类似下面这种的

 <dependency>
<groupId>org.eclipse.aether</groupId>
<artifactId>aether-connector-basic</artifactId>
<version>1.0.2.v20150114</version>
</dependency>
<dependency>
<groupId>org.eclipse.aether</groupId>
<artifactId>aether-transport-wagon</artifactId>
<version>1.0.2.v20150114</version>
</dependency>

但是实际上 aether 这个项目已经停止了,详见 Aether Termination Review,而 Apache Maven Artifact Resolver 就是替代者。

使用

使用的代码也很简单

public static void deploy(String path){
MavenCli cli = new MavenCli();
String mvnHome = MavenCli.USER_MAVEN_CONFIGURATION_HOME.getAbsolutePath();
System.getProperties().setProperty("maven.multiModuleProjectDirectory", mvnHome);
List<String> args = new ArrayList<>();
args.add("clean");
args.add("deploy");
int status = 0;
try {
status = cli.doMain(args.toArray(new String[]{}), path, System.out, System.out);
}catch (Exception e){
logger.error(e.getMessage(),e);
throw e;
}
if (status != 0) {
throw new RuntimeException("maven 出错");
}
}

maven.multiModuleProjectDirectory 这个系统变量,如果设置了就无需设置了,但如果没有就需要设置,否则会报错。

另外因为 deploy 时涉及服务器的账户和密码,可能需要配置文件,这里有两种解决方案:

  1. 通过 -s,--settings 来指定配置文件的路径。
  2. 把配置文件放到 maven home 中。

如果使用了密码加密,还涉及 settings-security.xml 文件,这时用第一种就行不太通(主要我没成功),把这两个文件都放到 maven home 是没啥问题的。默认的 maven home 就是用户目录下的.m2目录。

常见错误

-Dmaven.multiModuleProjectDirectory system property is not set.

前面提到了,设置这个系统变量就可以了,值为 maven home 对应的路径即可。

No implementation for org.apache.maven.repository.RepositorySystem was bound.

添加依赖,虽然这是个maven 2 的兼容包,但是还没找到其他的可替代品。

<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-compat</artifactId>
<version>3.6.3</version>
</dependency>

No connector factories available、No transporter factories registered

这两个都是部署过程中会报出的错误,添加如下依赖即可解决

<dependency>
<groupId>org.apache.maven.resolver</groupId>
<artifactId>maven-resolver-connector-basic</artifactId>
<version>1.4.1</version>
</dependency>
<dependency>
<groupId>org.apache.maven.resolver</groupId>
<artifactId>maven-resolver-transport-http</artifactId>
<version>1.4.1</version>
</dependency>
版权声明
本文为[码农张思壮]所创,转载请带上原文链接,感谢
https://segmentfault.com/a/1190000037758342

  1. 【计算机网络 12(1),尚学堂马士兵Java视频教程
  2. 【程序猿历程,史上最全的Java面试题集锦在这里
  3. 【程序猿历程(1),Javaweb视频教程百度云
  4. Notes on MySQL 45 lectures (1-7)
  5. [computer network 12 (1), Shang Xuetang Ma soldier java video tutorial
  6. The most complete collection of Java interview questions in history is here
  7. [process of program ape (1), JavaWeb video tutorial, baidu cloud
  8. Notes on MySQL 45 lectures (1-7)
  9. 精进 Spring Boot 03:Spring Boot 的配置文件和配置管理,以及用三种方式读取配置文件
  10. Refined spring boot 03: spring boot configuration files and configuration management, and reading configuration files in three ways
  11. 精进 Spring Boot 03:Spring Boot 的配置文件和配置管理,以及用三种方式读取配置文件
  12. Refined spring boot 03: spring boot configuration files and configuration management, and reading configuration files in three ways
  13. 【递归,Java传智播客笔记
  14. [recursion, Java intelligence podcast notes
  15. [adhere to painting for 386 days] the beginning of spring of 24 solar terms
  16. K8S系列第八篇(Service、EndPoints以及高可用kubeadm部署)
  17. K8s Series Part 8 (service, endpoints and high availability kubeadm deployment)
  18. 【重识 HTML (3),350道Java面试真题分享
  19. 【重识 HTML (2),Java并发编程必会的多线程你竟然还不会
  20. 【重识 HTML (1),二本Java小菜鸟4面字节跳动被秒成渣渣
  21. [re recognize HTML (3) and share 350 real Java interview questions
  22. [re recognize HTML (2). Multithreading is a must for Java Concurrent Programming. How dare you not
  23. [re recognize HTML (1), two Java rookies' 4-sided bytes beat and become slag in seconds
  24. 造轮子系列之RPC 1:如何从零开始开发RPC框架
  25. RPC 1: how to develop RPC framework from scratch
  26. 造轮子系列之RPC 1:如何从零开始开发RPC框架
  27. RPC 1: how to develop RPC framework from scratch
  28. 一次性捋清楚吧,对乱糟糟的,Spring事务扩展机制
  29. 一文彻底弄懂如何选择抽象类还是接口,连续四年百度Java岗必问面试题
  30. Redis常用命令
  31. 一双拖鞋引发的血案,狂神说Java系列笔记
  32. 一、mysql基础安装
  33. 一位程序员的独白:尽管我一生坎坷,Java框架面试基础
  34. Clear it all at once. For the messy, spring transaction extension mechanism
  35. A thorough understanding of how to choose abstract classes or interfaces, baidu Java post must ask interview questions for four consecutive years
  36. Redis common commands
  37. A pair of slippers triggered the murder, crazy God said java series notes
  38. 1、 MySQL basic installation
  39. Monologue of a programmer: despite my ups and downs in my life, Java framework is the foundation of interview
  40. 【大厂面试】三面三问Spring循环依赖,请一定要把这篇看完(建议收藏)
  41. 一线互联网企业中,springboot入门项目
  42. 一篇文带你入门SSM框架Spring开发,帮你快速拿Offer
  43. 【面试资料】Java全集、微服务、大数据、数据结构与算法、机器学习知识最全总结,283页pdf
  44. 【leetcode刷题】24.数组中重复的数字——Java版
  45. 【leetcode刷题】23.对称二叉树——Java版
  46. 【leetcode刷题】22.二叉树的中序遍历——Java版
  47. 【leetcode刷题】21.三数之和——Java版
  48. 【leetcode刷题】20.最长回文子串——Java版
  49. 【leetcode刷题】19.回文链表——Java版
  50. 【leetcode刷题】18.反转链表——Java版
  51. 【leetcode刷题】17.相交链表——Java&python版
  52. 【leetcode刷题】16.环形链表——Java版
  53. 【leetcode刷题】15.汉明距离——Java版
  54. 【leetcode刷题】14.找到所有数组中消失的数字——Java版
  55. 【leetcode刷题】13.比特位计数——Java版
  56. oracle控制用户权限命令
  57. 三年Java开发,继阿里,鲁班二期Java架构师
  58. Oracle必须要启动的服务
  59. 万字长文!深入剖析HashMap,Java基础笔试题大全带答案
  60. 一问Kafka就心慌?我却凭着这份,图灵学院vip课程百度云