wechat spring boot starter

WeChat 関連のコンポーネントはまだ改善中です。このプロジェクトを認識してくださった JetBrains に感謝します。プロジェクト アドレス: https://github.com/lcy19930619/wechat-spring-boot-starter。
Wiki アドレス: https://github.com/lcy19930619/wechat-spring-boot-starter/wiki

なぜこのコンポーネントが表示されるのでしょうか?

WeChat のドキュメントに書かれている内容は少しごちゃごちゃしているように感じられ、Baidu や csdn などのコードの再利用性が高くないため、より汎用性を高めるためにこのコンポーネントを作成しました。 。

対象バージョン

• JDK 21
• スプリングブート 3.2.0+ 以降

基本機能

WeChat ユーザーと公式アカウント間のやり取りに関する情報を受け取る

• テキストメッセージ
• 画像情報
• 音声情報
• ビデオ情報
• ちょっとした動画情報
• 地理位置情報
• リンク情報

WeChatユーザーや公式アカウントによるイベント情報を受け取る

• ユーザーの注意
• ユーザーがフォローを解除する
• ユーザーがフォローしていない場合
• ユーザーがフォローしたときにパラメーターを含む QR コードをスキャンします
• 地理的位置を報告する
• テンプレート配信実績
• メニューをクリックしてメッセージをプルするときのイベントプッシュ
• メニュージャンプリンククリック時のイベントプッシュ
• メニュースキャンコードプッシュイベントのイベントプッシュ
• QR コードをスキャンしてイベントをプッシュし、「メッセージ受信」プロンプト ボックスをポップアップ表示します。
• 写真撮影・投稿のポップアップシステムイベントプッシュ
• 写真を撮ったり、アルバムに写真を投稿したりするためのポップアップ イベント プッシュ
• WeChatフォトアルバム送信者のポップアップイベントプッシュ
• ポップアップロケーションセレクターのイベントプッシュ
• メニューをクリックするとアプレットのイベントプッシュにジャンプします

ユーザーとWeChatパブリックアカウント間の情報の暗号化された送信

設定ファイルを通じてオンにすると、情報が暗号化および復号化されます。WeChat バックグラウンド --- 基本設定 --- サーバー設定でメッセージの暗号化と復号化の方法を次のように設定する必要があります。

使用方法

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>

必要なコンポーネントを選択して追加します

WeChatイベントおよびメッセージアクセスモジュール

netty を使用して WeChat 公開アカウントにアクセスする

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

http 経由で WeChat 公式アカウントにアクセスします

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

使用例 1: カスタム メッセージ プロセッサを追加する

ステップ：

• AbstractWeChatMessageListener (抽象メッセージ処理リスナー) の継承
• 対応するメソッドを実装する
• Bean の管理と@Componentアノテーションの追加は Spring に任せます。

サンプルコードは次のとおりです。

 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 ( "回复用户一个文本信息" );
    }
}

使用例 2: カスタム イベント ハンドラーを追加する

ステップ：

• AbstractWeChatEventListener (抽象イベント処理リスナー) の継承
• 対応するメソッドを実装する
• Bean の管理と@Componentアノテーションの追加は Spring に任せます。サンプルコードは次のとおりです。

 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" );
    }
}

WeChatパブリックアカウントの各種機能入口（トークン管理の導入が必要）

該当するシナリオ:

• さまざまな WeChat インターフェースを呼び出す必要がある
• WeChatの文書が理解できません

メイブン座標

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

例: 基本的なユーザー情報の取得

 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 ));
    }
}

トークン管理モジュール、デフォルトの mysql 実装

該当するシナリオ:

• 永続トークンと JS API チケットが必要です
• WeChatインターフェースを呼び出す必要があります
• mysql環境があること
• 永続化レイヤーのカスタム実装はありません
• トークンを自動的に管理します (トークンを自動的に更新する機能はありません)

メイブン座標

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

拡張ポイント

• WeChatTokenRepositoryトークン永続層エントリ
• WeChatJsApiTicketRepository チケット永続層エントリ
• IpSegmentRepository 信頼できる IP 管理の入り口。リクエスト データが WeChat からのものかどうかを判断するために使用されます。
• WeChatAiBotTokenRepository WeChat のオープンソース AI ロボット (なぜ gpt を使用しないのですか? リクエストが 5 秒以内に完全に返されることを保証できますか? 公式アカウントは SSE プロトコルをサポートしていません)

コード例: カスタム永続層トークン管理

ステップ：

• インターフェースを実装する
• 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 ;
    }
}

シンプルなセキュリティモジュール

該当するシナリオ

• WeChat サーバーから受信したデータを認証したいと考えています。

特別な注意

• タイマーモジュールが導入されていない場合は、自分でタイマーを実装し、WeChatサーバーのIPアドレス情報を更新する必要があります。

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

シンプルなタイマーモジュール

該当するシナリオ

• 単一のアプリケーション
• トークンやチケットを自分で管理したくない

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

基礎となるモジュールの一部のみが必要な場合は、オンデマンドで導入することもできます。

WeChatインターフェースアクセスパラメータオブジェクトコレクション

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

WeChatイベントコールバック処理

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

WeChatインターフェースメソッドモジュール

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

イベントパターンの実行原理

• Spring Boot の spi メカニズム (つまり、/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports) ファイルを介して Spring Bean を登録し、すべてのコンポーネントをロードします。
• WeChat イベント コールバックを受信し、EventBus を通じて関連処理を実行します。

注意事項

• メッセージは 1 つのリスナーのみを使用できます
• イベントで使用できるリスナーは 1 つだけです
• 内蔵プロセッサがビジネス ニーズを満たせない場合、または WeChat が新しいメッセージやイベントを拡張する場合は、次の 2 つの Bean を処理用に登録できます。
  • UnKnowWeChatEventListener
  • UnKnowWeChatMessageListener

イベント実行処理

ネットモード

1. システムの起動時に wechat-event-netty-spring-boot-starter が初期化され、WeChatEventNettyServer.javanetty サーバーが起動されます。
2. WeChat リクエストが到着すると、WeChatChannelMessageHandler.java が動作を開始します。 3. セキュリティ サポート モジュール wechat-security-spring-boot-starter が追加されている場合、リクエストの IP は SecurityHandler.java を通じてチェックされます。 4. リクエストは EventBus に転送されます。 java 5. WeChat リクエストのデータを解析し、イベントと MsgType に従ってリスナー (つまり、自分で作成したビジネス リスナー) に基づいてデータを検索し、ioc コンテナに登録します。
6. リスナーのハンドラー メソッドを呼び出して、関連サービスを実行します。
7. WeChatサーバーにデータを返す

ウェブモード

1. wechat-event-web-spring-boot-starter はシステムの起動時に初期化され、WeChatMessageController をプログラムの入り口として登録します。 2. WeChat データ要求が WeChatMessageController に送信され、ホワイトリスト認証が実行されます。 3. リクエストを EventBus に転送します。
4. WeChatリクエストデータを解析し、イベントとMsgTypeに従ってiocコンテナに登録されているリスナー（つまり、自分で作成したビジネスリスナー）を見つけます。
5. リスナーのハンドラー メソッドを呼び出して、関連サービスを実行します。
6. WeChatサーバーにデータを返す

完全な構成ファイル

 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