wechat spring boot starter

Les composants liés à WeChat sont toujours en cours d'amélioration. Merci à JetBrains d'avoir reconnu l'adresse de ce projet : https://github.com/lcy19930619/wechat-spring-boot-starter.
Adresse wiki : https://github.com/lcy19930619/wechat-spring-boot-starter/wiki

Pourquoi ce composant apparaît-il ?

Certaines des choses écrites dans les documents WeChat semblent un peu compliquées, et beaucoup de choses doivent être trouvées et recherchées. La réutilisabilité du code de Baidu, csdn, etc. n'est pas élevée, j'ai donc écrit ce composant dans l'espoir d'une meilleure polyvalence. .

Version applicable

• jdk21
• Spring Boot 3.2.0+ ou supérieur

Fonctions de base

Recevoir des informations sur les interactions entre les utilisateurs de WeChat et les comptes officiels

• SMS
• Informations sur l'image
• informations audio
• Informations vidéo
• Petite information vidéo
• Informations de géolocalisation
• Informations sur le lien

Recevez des informations sur les événements déclenchés par les utilisateurs de WeChat et les comptes officiels

• Attention de l'utilisateur
• L'utilisateur ne suit plus
• Lorsque l'utilisateur ne suit pas
• Scannez le code QR avec les paramètres lorsque l'utilisateur a suivi
• Signaler la situation géographique
• Résultats de livraison du modèle
• Événement push en cliquant sur le menu pour extraire le message
• Événement poussé en cliquant sur le lien de saut de menu
• Événement push de l'événement push de code d'analyse de menu
• Scannez le code QR pour envoyer des événements et afficher la boîte de dialogue « Réception de message ».
• Push d'événement système pop-up pour prendre des photos et publier des photos
• Événement pop-up pour prendre des photos ou publier des photos dans des albums
• Événement pop-up de l'expéditeur de l'album photo WeChat
• Push d'événement pour le sélecteur d'emplacement contextuel
• Cliquez sur le menu pour accéder au push d'événement de l'applet

Transmission cryptée d'informations entre les utilisateurs et les comptes publics WeChat

Allumez-le via le fichier de configuration. Après l'avoir allumé, les informations seront cryptées et déchiffrées. Vous devez définir la méthode de cryptage et de décryptage des messages en arrière-plan WeChat --- Configuration de base --- Configuration du serveur comme : Mode sans échec.

Comment utiliser

Ajouter une dépendance de gestion de version Maven

 <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>net.jlxxw</groupId>
                <artifactId>wechat-spring-boot-starter</artifactId>
                 <version>${最新版本请查看仓库}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

Sélectionnez pour ajouter les composants requis

Module d'accès aux événements et aux messages WeChat

Utilisez Netty pour accéder au compte public WeChat

< dependency >
    < groupId >net.jlxxw</ groupId >
    < artifactId >wechat-event-netty-spring-boot-starter</ artifactId >
</ dependency >

Accédez au compte officiel WeChat via http

< dependency >
    < groupId >net.jlxxw</ groupId >
    < artifactId >wechat-event-web-spring-boot-starter</ artifactId >
</ dependency >

Exemple d'utilisation 1 : ajouter un processeur de messages personnalisé

étape:

• Hériter de AbstractWeChatMessageListener (écouteur de traitement de messages abstraits)
• Implémenter la méthode correspondante
• Laissez Spring gérer le bean et ajoutez @Component

L'exemple de code est le suivant :

 import net . jlxxw . wechat . event . component . listener . AbstractWeChatMessageListener ;
import net . jlxxw . wechat . dto . message . AbstractWeChatMessage ;
import net . jlxxw . wechat . enums . WeChatMessageTypeEnum ;
import net . jlxxw . wechat . response . WeChatMessageResponse ;
import org . springframework . stereotype . Component ;

/**
 * 用户发送消息监听器
 * @author chunyang.leng
 * @date 2021-12-18 6:19 下午
 */
@ Component
public class TextMessageListener extends AbstractWeChatMessageListener {
    /**
     * 支持的消息类型
     *
     * @return
     */
    @ Override
    public WeChatMessageTypeEnum supportMessageType () {

//      文本信息 WeChatMessageTypeEnum.TEXT
//      图片信息 WeChatMessageTypeEnum.IMAGE
//      语音信息 WeChatMessageTypeEnum.VOICE
//      视频信息 WeChatMessageTypeEnum.VIDEO
//      小视频信息 WeChatMessageTypeEnum.SHORT_VIDEO
//      地理位置信息 WeChatMessageTypeEnum.LOCATION
//      链接信息 WeChatMessageTypeEnum.LINK
//      更多类型，参考枚举 WeChatMessageTypeEnum
        return WeChatMessageTypeEnum . TEXT ;
    }
    /**
     * 处理微信消息 ,return null时，会转换为 "" 返回到微信服务器
     */
    @ Override
    public WeChatMessageResponse handler ( AbstractWeChatMessage abstractWeChatMessage ) {
        // 类型转化参考 supportMessageType() 方法中枚举定义
        TextMessage textMessage = ( TextMessage ) abstractWeChatMessage ;
        // 用户发送的内容
        String content = textMessage . getContent ();
        // 用户openId
        String fromUserName = textMessage . getFromUserName ();

      // 返回图文信息，具体内容补充方法参数即可
      // WeChatMessageResponse.buildArticle();
      // 返回图片信息，具体内容补充方法参数即可
      // WeChatMessageResponse.buildImage();
      // 返回音乐信息，具体内容补充方法参数即可
      // WeChatMessageResponse.buildMusic();
      // 返回文本信息，具体内容补充方法参数即可
      // WeChatMessageResponse.buildText();
      // 返回视频信息，具体内容补充方法参数即可
      // WeChatMessageResponse.buildVideo();
      // 返回音频信息，具体内容补充方法参数即可
      // WeChatMessageResponse.buildVoice();
        return WeChatMessageResponse . buildText ( "回复用户一个文本信息" );
    }
}

Exemple d'utilisation 2 : Ajouter un gestionnaire d'événements personnalisé

étape:

• Hériter de AbstractWeChatEventListener (écouteur de traitement d'événements abstraits)
• Implémenter la méthode correspondante
• Laissez Spring gérer le bean et ajoutez @Component . L'exemple de code est le suivant :

 import net . jlxxw . wechat . dto . message . event . SubscribeEventMessage ;
import net . jlxxw . wechat . event . component . listener . AbstractWeChatEventListener ;
import net . jlxxw . wechat . dto . message . AbstractWeChatMessage ;
import net . jlxxw . wechat . enums . WeChatEventTypeEnum ;
import net . jlxxw . wechat . response . WeChatMessageResponse ;
import org . junit . Assert ;
import org . springframework . stereotype . Component ;

/**
 * 用户关注事件监听器
 * @author chunyang.leng
 * @date 2021-12-19 7:08 下午
 */
@ Component
public class SubscribeEventMessageListener extends AbstractWeChatEventListener {
    /**
     * 支持的事件类型
     */
    @ Override
    public WeChatEventTypeEnum supportEventType () {

//      文本信息 WeChatMessageTypeEnum.TEXT
//      图片信息 WeChatMessageTypeEnum.IMAGE
//      语音信息 WeChatMessageTypeEnum.VOICE
//      视频信息 WeChatMessageTypeEnum.VIDEO
//      小视频信息 WeChatMessageTypeEnum.SHORT_VIDEO
//      地理位置信息 WeChatMessageTypeEnum.LOCATION
//      链接信息 WeChatMessageTypeEnum.LINK
//      更多类型，参考枚举 WeChatMessageTypeEnum

      return WeChatEventTypeEnum . SUBSCRIBE ;
    }

    /**
     * 处理微信消息 ,return null时，会转换为 "" 返回到微信服务器
     */
    @ Override
    public WeChatMessageResponse handler ( AbstractWeChatMessage abstractWeChatMessage ) {
        Assert . assertNotNull ( "接收到的数据不应为空" , abstractWeChatMessage );
        // 类型转化参考 supportMessageType() 方法中枚举定义
        SubscribeEventMessage subscribeEventMessage = ( SubscribeEventMessage ) abstractWeChatMessage ;
        // 用户关注 event key
        String eventKey = subscribeEventMessage . getEventKey ();
        // 用户openId
        String fromUserName = subscribeEventMessage . getFromUserName ();


      // 返回图文信息，具体内容补充方法参数即可
      // WeChatMessageResponse.buildArticle();
      // 返回图片信息，具体内容补充方法参数即可
      // WeChatMessageResponse.buildImage();
      // 返回音乐信息，具体内容补充方法参数即可
      // WeChatMessageResponse.buildMusic();
      // 返回文本信息，具体内容补充方法参数即可
      // WeChatMessageResponse.buildText();
      // 返回视频信息，具体内容补充方法参数即可
      // WeChatMessageResponse.buildVideo();
      // 返回音频信息，具体内容补充方法参数即可
      // WeChatMessageResponse.buildVoice();
        return WeChatMessageResponse . buildText ( supportEventType (). getDescription () + " done" );
    }
}

Diverses entrées de fonctions pour les comptes publics WeChat (la mise en œuvre de la gestion des jetons doit être introduite)

Scénarios applicables :

• Besoin d'appeler diverses interfaces WeChat
• Je ne comprends pas les documents WeChat

coordonnées maven

< dependency >
    < groupId >net.jlxxw</ groupId >
    < artifactId >wechat-function-spring-boot-starter</ artifactId >
</ dependency >

Exemple : Obtenir des informations utilisateur de base

 import net . jlxxw . wechat . enums . LanguageEnum ;
import net . jlxxw . wechat . function . WeChatFunctionAutoConfiguration ;
import net . jlxxw . wechat . response . user . SubscriptionResponse ;
import org . springframework . beans . factory . annotation . Autowired ;
import org . springframework . beans . factory . annotation . Value ;
import org . springframework . boot . test . context . SpringBootTest ;
import org . springframework . test . context . ActiveProfiles ;
import org . springframework . test . context . TestPropertySource ;
import org . springframework . util . CollectionUtils ;
import org . springframework . stereotype . Component ;

@ Component
public class UserManagerTest  {

    @ Autowired
    public UserManager userManager ;

    public void getUserInfoTest ( String openId ) {
        
        SubscriptionResponse userInfo = userManager . getUserInfo ( openId , LanguageEnum . ZH_CN );
        Assert . assertTrue ( "查询到的用户信息不应为空" , Objects . nonNull ( userInfo ));
    }
}

module de gestion de jetons, implémentation mysql par défaut

Scénarios applicables :

• Nécessite un jeton persistant et un ticket API js
• Besoin d'appeler l'interface WeChat
• Avoir un environnement MySQL
• Aucune implémentation personnalisée de la couche de persistance
• Gérer automatiquement les jetons (n'a pas la possibilité de mettre à jour automatiquement les jetons)

coordonnées maven

< dependency >
    < groupId >net.jlxxw</ groupId >
    < artifactId >wechat-repository-mysql-spring-boot-starter</ artifactId >
</ dependency >

point d'extension

• Entrée de la couche de persistance WeChatTokenRepositorytoken
• Entrée de la couche de persistance des tickets WeChatJsApiTicketRepository
• IpSegmentRepository Entrée de gestion IP approuvée, utilisée pour déterminer si les données de la demande proviennent de WeChat
• WeChatAiBotTokenRepository Le robot ai open source de WeChat (pourquoi ne pas utiliser gpt ? Pouvez-vous garantir que la demande sera entièrement renvoyée dans les 5 secondes ? Le compte officiel ne prend pas en charge le protocole SSE)

Exemple de code : gestion des jetons de couche de persistance personnalisée

étape:

• implémenter l'interface
• Laissez le soin à la direction de Spring

 import net . jlxxw . wechat . repository . token . WeChatTokenRepository ;
import org . springframework . stereotype . Component ;

/**
 * @author chunyang.leng
 * @date 2024-01-12 17:45
 */
@ Component
public class MyTokenRepositoryImpl implements WeChatTokenRepository {

    /**
     * 保存token
     *
     * @param token
     */
    @ Override
    public void save ( String token ) {
        
    }

    /**
     * 获取保存在本地的token
     *
     * @return 保存在本地的token
     */
    @ Override
    public String get () {
        return null ;
    }
}

Module de sécurité simple

Scénarios applicables

• J'espère authentifier les données reçues, qui proviennent du serveur WeChat.

attention particulière

• Si le module de minuterie n'est pas introduit, vous devez implémenter la minuterie vous-même et mettre à jour les informations d'adresse IP du serveur WeChat.

< dependency >
    < groupId >net.jlxxw</ groupId >
    < artifactId >wechat-security-spring-boot-starter</ artifactId >
</ dependency >

Module de minuterie simple

Scénarios applicables

• Demande unique
• Vous ne souhaitez pas gérer vous-même les jetons et les tickets

< dependency >
    < groupId >net.jlxxw</ groupId >
    < artifactId >wechat-simple-schedule-spring-boot-starter</ artifactId >
</ dependency >

Si vous n’avez besoin que de certains modules sous-jacents, vous pouvez également les introduire à la demande.

Collection d'objets de paramètres d'accès à l'interface WeChat

< dependency >
  < groupId >net.jlxxw</ groupId >
  < artifactId >wechat-common</ artifactId >
</ dependency >

Traitement des rappels d'événements WeChat

< dependency >
  < groupId >net.jlxxw</ groupId >
  < artifactId >wechat-event</ artifactId >
</ dependency >

Module de méthode d'interface WeChat

< dependency >
  < groupId >net.jlxxw</ groupId >
  < artifactId >wechat-event</ artifactId >
</ dependency >

Principe d'exécution du modèle d'événement

• Enregistrez les beans Spring via le mécanisme spi de Spring Boot (c'est-à-dire : scan /resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports) pour charger tous les composants.
• Recevez des rappels d'événements WeChat et effectuez le traitement associé via EventBus

Choses à noter

• Un message ne peut utiliser qu'un seul auditeur
• Un événement ne peut utiliser qu'un seul écouteur
• Si le processeur intégré ne peut pas répondre aux besoins de l'entreprise ou si WeChat développe de nouveaux messages et événements, vous pouvez enregistrer les deux beans suivants pour le traitement
  • UnKnowWeChatEventListener
  • UnKnowWeChatMessageListener

Processus d'exécution d'un événement

mode net

1. wechat-event-netty-spring-boot-starter s'initialise au démarrage du système et démarre le serveur WeChatEventNettyServer.javanetty
2. Lorsque la requête WeChat arrive, WeChatChannelMessageHandler.java commence à fonctionner 3. Si le module de support de sécurité wechat-security-spring-boot-starter est ajouté, l'adresse IP de la requête est vérifiée via SecurityHandler.java 4. La requête est transmise à EventBus. java 5. L'analyse de WeChat demande des données, les recherche et les enregistre dans le conteneur ioc en fonction de l'événement et du MsgType à l'écouteur (c'est-à-dire l'écouteur professionnel écrit par vous-même)
6. Appelez la méthode du gestionnaire de l'écouteur pour effectuer les services associés
7. Renvoyez les données au serveur WeChat

mode Internet

1. wechat-event-web-spring-boot-starter est initialisé au démarrage du système et enregistre WeChatMessageController comme entrée du programme 2. Les demandes de données WeChat sont envoyées à WeChatMessageController et une authentification par liste blanche est effectuée. 3. Transférez la demande à EventBus
4. Analysez les données de la demande WeChat, recherchez l'auditeur enregistré dans le conteneur ioc en fonction de l'événement et du MsgType (c'est-à-dire l'auditeur professionnel écrit par vous-même)
5. Appelez la méthode du gestionnaire de l'écouteur pour effectuer les services associés
6. Renvoyez les données au serveur WeChat

Fichier de configuration complet

 wechat :
  # 需要替换为真实数据
  app-id : wx97562dcec7e78aca
  # 需要替换为真实数据
  secret : 995bc3e1c1e0d30884f3d2e1f033eced
  verify-token : mytoken123456
  # 需要替换为真实数据
  encoding-aes-key : 9hFP1tCoPIRB8rFk4ukaYn6bw1Gbxs53yIGVplNsxxx
  event :
    server :
      # 引入 event-netty 使用，与 event-web 互斥
      netty :
        codec : cipher_text
        port : 9999
        log :
          enable : true
          level : debug
        verify-token-url : /verify
        core-controller-url : /we
      # 引入 event-web 使用，与 event-netty 互斥
      web :
        core-controller-url : /we
        codec : cipher_text
  # 引入 wechat-repository-mysql-spring-boot-starter 使用
  repository :
    mysql :
      enable-auto-create-js-api-table : true
      enable-auto-create-token-table : true