很多时候，项目里面会引入各种同公司写的依赖，而这些依赖有时候更新到了nexus私服，其他人又不知道，导致本地的代码执行不符合预期。
我们这就有这种情况，因为依赖还处于开发阶段，并不是一个release版本，maven又是设置的不会每次都会去下载快照，就导致有人没有拉取最新的包写代码。为了避免这种情况，就考虑写一个maven插件，在deploy的时候，群里发一个通知。
大概的步骤就是下面5步，最后一步查看是否能正确发送消息。
- 创建一个maven插件项目
- 引入插件开发所需的依赖
- 编写发送通知的代码，然后
install打包供其他项目当插件使用 - 项目
pom文件build里面引入这个通知插件，创建一个企业微信机器人，拿到钩子地址，配置插件url属性 - 项目
deploy，看企业微信是否收到消息
详细步骤：
创建maven项目
Idea新建一个普通的maven项目，名字的话，maven不要放在最前面，官方说，一般约定maven在最前面的是官方插件。
重要：packaging设置为maven-plugin，不然deploy的时候，会报错找不到plugin.xml
引入插件所需所需依赖
这个插件里面有后面要用到的注解和抽象类等等，设置为provided是因为到时候我们引入这个插件deploy的时候，他有这些依赖，打包的时候不用弄进去。
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven-plugin-tools.version>3.5.2</maven-plugin-tools.version>
</properties>
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>${maven-plugin-tools.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<version>${maven-plugin-tools.version}</version>
<scope>provided</scope>
</dependency>
</dependencies>
完整的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>cn.mvn</groupId>
<artifactId>wechat-notify-deploy-maven</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>maven-plugin</packaging>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven-plugin-tools.version>3.5.2</maven-plugin-tools.version>
</properties>
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>${maven-plugin-tools.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<version>${maven-plugin-tools.version}</version>
<scope>provided</scope>
</dependency>
</dependencies>
</project>
编写代码
首先编写一个http请求工具类，发送http请求我们用java原生的，还需要弄一个map转json的方法。之所以不用三方依赖比如hutool等是因为install这个插件项目的时候会报错。
package cn.mvn.notify.util;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.Map;
/**
* http请求工具，目前只用来发送post（主要是用gtp生成的，自己加了一个map里面value有map的类型处理）
*/
public final class HttpUtil {
private HttpUtil() {
}
/**
* 发送POST请求并接收响应
*
* @param url 请求URL
* @param params 请求参数，Map形式
* @return 响应结果字符串
* @throws Exception 如果网络错误发生
*/
public static String sendPostRequest(String url, Map<String, Object> params) throws Exception {
HttpURLConnection connection = null;
String result;
String urlParameters = convertMapToJson(params); // 将Map转换为JSON字符串
try {
URL requestUrl = new URL(url);
connection = (HttpURLConnection) requestUrl.openConnection();
connection.setRequestMethod("POST");
connection.setRequestProperty("Content-Type", "application/json; charset=UTF-8");
connection.setRequestProperty("Accept", "application/json");
connection.setDoOutput(true); // 发送POST请求必须设置允许输出
connection.setDoInput(true); // 允许输入流读取服务器响应
// 写入请求体
try (OutputStream outputStream = connection.getOutputStream()) {
byte[] input = urlParameters.getBytes(StandardCharsets.UTF_8);
outputStream.write(input, 0, input.length);
}
// 读取响应
StringBuilder builder = new StringBuilder();
try (BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
String line;
while ((line = in.readLine()) != null) {
builder.append(line);
}
}
result = builder.toString();
} finally {
if (connection != null) {
connection.disconnect();
}
}
return result;
}
/**
* 将Map转换为JSON字符串
*
* @param map 要转换的Map
* @return JSON字符串
*/
private static String convertMapToJson(Map<String, Object> map) {
// 这里简化处理，直接构造一个简单的JSON字符串。
// 实际应用中可能需要使用如Jackson或Gson库来进行更复杂的对象转换。
StringBuilder json = new StringBuilder();
json.append("{");
for (Map.Entry<String, Object> entry : map.entrySet()) {
Object value = entry.getValue();
// 这里复杂类型只考虑map中含有Map类型的情况，不考虑含有list等其他类型的情况
if (value instanceof Map) {
json.append("\"").append(entry.getKey()).append("\":").append(convertMapToJson((Map<String, Object>) value))
.append(",");
} else {
json.append("\"").append(entry.getKey()).append("\":\"").append(value).append("\",");
}
}
if (json.length() > 1) {
json.setLength(json.length() - 1); // 移除最后一个逗号
}
json.append("}");
return json.toString();
}
}
接下来编写一个通知Mojo类，必须要实现AbstractMojo抽象类，然后重写execute方法，当我们使用这个插件的时候，会调用execute方法
package cn.mvn.notify.mojo;
import cn.mvn.notify.util.HttpUtil;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
/**
* 通知mojo，定义Mojo（即插件中的goal）的注解，指定了这个Mojo（任务）的名称为wechat
* 这个name在后面引入插件的时候会用到
*/
@Mojo(name = "wechat")
public class NotifyMojo extends AbstractMojo {
/**
* 企业微信机器人钩子地址，在plugin/configuration/url中可以配置，required = true意思是必须填，不然会报错（Idea里面会爆红提示）
*/
@Parameter(required = true)
private String url;
/**
* defaultValue里配置${}拿到引入了这个插件的项目pom文件里面的一些参数，readonly代表不允许用户修改这些参数
*/
@Parameter(defaultValue = "${project.groupId}", readonly = true)
private String groupId;
@Parameter(defaultValue = "${project.artifactId}", readonly = true)
private String artifactId;
@Parameter(defaultValue = "${project.version}", readonly = true)
private String version;
/**
* 用来输出日志
*/
private final Log log = getLog();
@Override
public void execute() {
// 判断一下钩子地址是否为空 还可以判断一下地址格式是否合法，这个可以自己加一个正则
if (url.trim().isEmpty()) {
if (log.isErrorEnabled()) {
log.error("钩子地址为空");
}
return;
}
// 拼接要发送的消息
final String message = groupId + ":" + artifactId + ":" + version + " deploy到nexus";
final Map<String, Object> body = new HashMap<>(2);
// text类型
body.put("msgtype", "text");
body.put("text", Collections.singletonMap("content", message));
try {
//todo 发送通知，响应可以自己处理一下，比如判断是否含有正确响应的字符来判断是否发送成功
// {"errcode":0,"errmsg":"ok"} 这个是目前请求钩子地址正常的响应
String response = HttpUtil.sendPostRequest(url, body);
} catch (Exception e) {
// 如果异常了，就提示
if (log.isErrorEnabled()) {
log.error("发送异常，异常信息：" + e.getMessage(), e);
}
}
}
}
很简单，就这两个类，然后install安装到本地仓库，可以mvn clean install，或者直接在Idea中点install
项目里面引入通知插件，配置企业微信机器人钩子地址
configuration标签里面的url标签配置企业微信机器人钩子地址，其次就是配置一个execution让他在deploy的时候调用我们这个插件（其实@Mojo注解里面可以配置默认阶段defaultPhase = LifecyclePhase.DEPLOY，这样在depoly的时候就会自动执行，但是不知道为什么在我本地配置这个并没有用，所以用了这种execution的方式来配置）。
创建企业微信机器人的步骤，创建完把这个Webhook地址配置在url属性
引入完之后，在Idea里面，查看项目的Plugins，就可以看到我们的插件了，如果我们插件有问题（比如packaging没有配置成maven-plugin），他是会爆红色波浪线的
deploy测试插件是否可用
可以先双击Plugins里面的wechat-notify-deploy:wechat看一下，这样就会直接调用我们的插件，没有问题再deploy测试
双击之后，企业微信成功收到通知。除了用Idea直接点击调用，还可以通过mvn命令的方式调用和配置参数，有兴趣的可以问一下GPT
再测试deploy，同样正常收到通知。如果想给其他人使用这个插件，可以把插件deploy到私服。
注意： 插件deploy到私服之后，其他人要想拉取，项目里面需要在pluginRepositories标签配置仓库地址，和仓库地址标签repositories不是共用的。没有配置插件仓库地址的话，拉取的时候会报解析错误，在本地仓库查看是没有拉取下来的。
可以pom.xml里面配置，也可以settings.xml里面配置：
<pluginRepositories>
<pluginRepository>
<id>c-nexus</id>
<url>http://xxx.xxx.xxx.xxx:port/repository/maven-public/</url>
<layout>default</layout>
<snapshots>
<enabled>true</enabled>
</snapshots>
<releases>
<enabled>true</enabled>
</releases>
</pluginRepository>
</pluginRepositories>
