Spring Boot 集成企业微信开发

最新推荐文章于 2024-06-19 16:35:08 发布

orton777

最新推荐文章于 2024-06-19 16:35:08 发布

阅读量2.1k

点赞数

文章标签： spring boot 企业微信后端

本文链接：https://blog.csdn.net/orton777/article/details/131559542

版权

本文将详细介绍如何使用 Spring Boot 集成企业微信开发。企业微信是企业间的沟通工具，通过企业微信 API 可以实现企业内部的一些自动化业务流程，提高工作效率。文章将从实际应用场景出发，通过代码示例，讲解 Spring Boot 集成企业微信的具体步骤。

1. 开发环境准备

首先需要准备开发环境，确保已安装以下工具和环境：

JDK 1.8 及以上版本
Maven 3.0 及以上版本
Spring Boot 2.0 及以上版本
企业微信 API 账号

2. 创建 Spring Boot 项目

我们通过 Spring Initializr 来创建一个基本的 Spring Boot 项目，选择 Web 作为项目的依赖。

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
</dependencies>

3. 企业微信 API 配置

在开始开发之前，需要先在企业微信管理后台创建一个应用，并获得相关的配置信息。具体步骤如下：

登录企业微信管理后台，创建一个新的应用。
记录下应用的 AgentId、Secret、Token、EncodingAESKey 等配置信息。
设置应用的可信域名，以便接收企业微信推送的消息。

将这些配置信息添加到 application.yml 配置文件中：

wechat:
  corp-id: 'your-corp-id'
  agent-id: 'your-agent-id'
  secret: 'your-secret'
  token: 'your-token'
  encoding-aes-key: 'your-encoding-aes-key'

4. 集成企业微信 SDK

为了简化开发，我们可以使用第三方的企业微信 SDK。在本文中，我们选择使用 weixin-java-cp。将以下依赖添加到项目的 pom.xml 文件中：

<dependency>
  <groupId>com.github.binarywang</groupId>
  <artifactId>weixin-java-cp</artifactId>
  <version>latest-release-version</version>
</dependency>

5. 初始化企业微信服务类

创建一个用于初始化企业微信服务的配置类，并将企业微信的配置信息注入到该类中。创建 WxCpConfiguration.java 文件：

@Configuration
public class WxCpConfiguration {

  @Autowired
  private WeChatProperties weChatProperties;

  @Bean
  public WxCpService wxCpService() {
    WxCpInMemoryConfigStorage configStorage = new WxCpInMemoryConfigStorage();
    configStorage.setCorpId(weChatProperties.getCorpId());
    configStorage.setAgentId(weChatProperties.getAgentId());
    configStorage.setCorpSecret(weChatProperties.getSecret());
    configStorage.setToken(weChatProperties.getToken());
    configStorage.setAesKey(weChatProperties.getEncodingAesKey());

    WxCpService wxCpService = new WxCpServiceImpl();
    wxCpService.setWxCpConfigStorage(configStorage);
    return wxCpService;
  }
}

6. 开发企业微信消息处理器

企业微信推送的消息需要通过处理器进行处理。这里我们创建一个简单的消息处理器，用于处理文本消息。创建 MyTextMessageHandler.java 文件：

@Service
public class MyTextMessageHandler implements WxCpMessageHandler {

  @Override
  public WxCpXmlOutMessage handle(WxCpXmlMessage wxMessage, Map<String, Object> context, WxCpService wxCpService) {
    String content = "收到文本消息：" + wxMessage.getContent();
    return WxCpXmlOutMessage.TEXT().content(content).fromUser(wxMessage.getToUserName())
        .toUser(wxMessage.getFromUserName()).build();
  }
}

7. 创建企业微信控制器

现在我们需要创建一个企业微信控制器，用于处理企业微信发送过来的请求。创建 WxCpController.java 文件：

@RestController
@RequestMapping("/wechat/cp")
public class WxCpController {

  @Autowired
  private WxCpService wxCpService;

  @Autowired
  private MyTextMessageHandler myTextMessageHandler;

  @GetMapping(produces = "text/plain;charset=utf-8")
  public String auth(@RequestParam(name = "msg_signature") String signature,
                     @RequestParam(name = "timestamp") String timestamp,
                     @RequestParam(name = "nonce") String nonce,
                     @RequestParam(name = "echostr") String echostr) {
    try {
      if (wxCpService.checkSignature(timestamp, nonce, signature, echostr)) {
        return echostr;
      }
    } catch (Exception e) {
      e.printStackTrace();
    }
    return "非法请求";
  }

  @PostMapping(produces = "application/xml; charset=UTF-8")
  public String post(@RequestBody String requestBody,
                     @RequestParam("msg_signature") String signature,
                     @RequestParam("timestamp") String timestamp,
                     @RequestParam("nonce") String nonce) {
    try {
      WxCpXmlMessage inMessage = WxCpXmlMessage.fromEncryptedXml(requestBody, wxCpService.getWxCpConfigStorage(),
          timestamp, nonce, signature);
      WxCpXmlOutMessage outMessage = wxCpService.route(inMessage);

      if (outMessage != null) {
        return outMessage.toEncryptedXml(wxCpService.getWxCpConfigStorage());
      }
    } catch (Exception e) {
      e.printStackTrace();
    }
    return "";
  }
}

在控制器中，我们处理了两个请求：

GET 请求用于企业微信服务器验证 URL 的有效性。
POST 请求用于处理企业微信推送过来的消息。

8. 注册消息处理器

为了让企业微信服务类知道我们创建的消息处理器，我们需要将其注册到 WxCpMessageRouter 中。修改 WxCpConfiguration.java 文件，添加如下代码：

@Bean
public WxCpMessageRouter wxCpMessageRouter(WxCpService wxCpService, MyTextMessageHandler myTextMessageHandler) {
  WxCpMessageRouter wxCpMessageRouter = new WxCpMessageRouter(wxCpService);
  wxCpMessageRouter.rule().async(false).msgType(WxConsts.XmlMsgType.TEXT).handler(myTextMessageHandler).end();
  return wxCpMessageRouter;
}