ホーム>プログラミング関連>AI ソースコード
ダウンロード

微信プロジェクト

Wechattty プロジェクトは、WeChat パブリック アカウント (サービス アカウントおよびサブスクリプション アカウントを含む) および WeChat エンタープライズ アカウント用の JAVA ベースの開発フレームワークであり、適切にカプセル化された API により、開発者はビジネス ロジックの開発に集中でき、開発効率が向上します。

簡単な使い方チュートリアル

  • 依存関係を導入する
  • 初期化
  • 構成
  • メッセージを受信する
  • メッセージを送信する
  • 資材管理
  • アカウント管理
  • WeChatの認証
  • ウィーチャットペイ

依存関係を導入する

ここでは依存関係を導入するために Maven が使用されています。 

 <dependency>
  <groupId>space.chensheng.wechatty</groupId>
  <artifactId>wechatty-mp</artifactId>
  <version>2.0.0</version>
</dependency>

初期化

MpAppContext 、パブリック アカウント API の統合呼び出し入口であり、 WechatMpBootstrap使用して初期化されます。 

 WechatMpBootstrap bootstrap = new WechatMpBootstrap();
bootstrap.addMsgListener(new TextMessageListener());
MpAppContext mpAppContext = bootstrap.build();

プロジェクトが Spring を使用して管理されている場合は、後の参照のためにMpAppContext初期化するためにFactoryBean実装できます。 

 @Component
public class MpAppContextFactoryBean implements FactoryBean<MpAppContext> {

	@Override
	public MpAppContext getObject() throws Exception {
	    WechatMpBootstrap bootstrap = new WechatMpBootstrap();
	    bootstrap.addMsgListener(new TextMessageListener());
	    return bootstrap.build();
	}

	@Override
	public Class<?> getObjectType() {
	    return MpAppContext.class;
	}

	@Override
	public boolean isSingleton() {
	    return true;
	}
}

構成

設定方法は 2 つあり、1 つは配置文件、もう 1 つはJAVA代码配置です。 JAVA代码配置の優先順位は配置文件優先順位よりも高くなります。

設定ファイル

新しい構成ファイル wechat-mp.properties を作成し、そのファイルをプロジェクトのクラスパスに配置します。たとえば、Maven プロジェクトでは、このファイルはsrc/main/resourcesディレクトリに配置できます。一般的な構成は次のとおりです。 

 token=thisIsToken
aesKey=thisIsAesKey
appId=thisIsYourAppId
appSecret=thisIsAppSecret
JAVAコードの構成

MpAppConetxtが初期化されたら、構成のためにWechatMpBootstrapのcustomizeWechatContextメソッドを呼び出します。 

 WechatMpBootstrap bootstrap = new WechatMpBootstrap();
bootstrap.customizeWechatContext(new MpWechatContextCustomizer() {
    @Override
    public void customize(MpWechatContext wechatContext) {
	wechatContext.setToken("thisIsToken");
	wechatContext.setAesKey("thisIsAeskey");
	wechatContext.setAppId("thisIsAppId");
	wechatContext.setAppSecret("thisIsAppSecret");
    }
});
設定パラメータの説明
必須パラメータ説明する
トークン公式アカウントのトークンは、公式アカウントの背景で確認できます。
aesキー暗号化に使用されたキーは、公式アカウントのバックエンドで確認できます。
アプリID公式アカウントのappIdは、公式アカウントのバックグラウンドで確認できます。
アプリの秘密公式アカウントのappSecretは、公式アカウントのバックグラウンドで確認できます。
オプションのパラメータ説明する
暗号化モードを有効にするコールバック暗号化モードを有効にするかどうか。デフォルトは true。これがオンになっている場合は、JCE 無制限アクセス許可ポリシー ファイルをダウンロードして、jdk 内の関連ファイルをカバーする必要があります。詳細については、WeChat の一般的なエラーの例を参照してください。
autoUpdateAccessToken access_token 関連のエラーが発生したときに、access_token を自動的に更新するかどうか。デフォルトは false です。後で詳しく説明します。
accessTokenStrategyClass access_token アクセス戦略 (デフォルトは space.chensheng.wechatty.common.http.MemoryAccessTokenStrategy) は、access_token をメモリに保存します。アプリケーションは、データベースに保存するなど、独自のアクセス戦略を実装できます。これについては、後で説明します。詳細は後ほど。
ペイキーWeChat 支払いキー
payCertファイルWeChat支払い証明書ファイルのパス
支払い証明書パスワードWeChat支払い証明書のパスワード
支払いMchId WeChat 決済の販売者 ID
PayClientIp支払いのためにマシンの IP に電話します
プーリングHttpProxyEnableプロキシ サーバー経由で WeChat サーバーをリクエストするかどうか。デフォルトは false です。
プーリングHTTPプロキシホスト名プロキシ サーバーのホスト名 (www.chensheng.space など)
プーリングHTTPプロキシポートプロキシサーバーポート
プーリングHttpProxyユーザー名プロキシサーバーのユーザー名
プーリングHTTPプロキシパスワードプロキシサーバーのパスワード
プーリングHttpMaxPerRoute http 接続プール内のリンクあたりの同時接続の最大数。デフォルトは 50 です。
プーリングHttpMaxTotal http 接続プール内の最大同時接続数、デフォルトは 200
プーリングHttpSocketTimeoutミリスソケットタイムアウトのミリ秒数、デフォルトは 10000
プーリングHttpConnectTimeoutミリスWeChat サーバーへの接続タイムアウトのミリ秒数、デフォルトは 10000
プーリングHttpConnectionRequestTimeoutミリスhttp 接続プールから接続タイムアウト ミリ秒を取得します (デフォルトは 10000)
プーリングHttpTcpNoDelay tpcNoDelay を有効にするかどうか、デフォルトは true
access_token 更新の問題
  • 自動更新: 自動更新がオンになっている場合、access_token エラーにより WeChat インターフェイスへのリクエストが失敗した場合、フレームワークは access_token を自動的に更新します。
  • スケジュールされた更新: アプリケーションでスケジュールされたタスク (quartz など) を使用して、 mpAppContext.getAccessTokenFetcher().updateAccessToken()定期的に (通常は 1.5 時間に 1 回) 実行します。これは、access_token の有効期限が 2 時間であるためです。
  • 自動更新とスケジュールされた更新は共存できます。複数のスレッドが更新 access_token を同時に実行する場合、1 つのスレッドだけが WeChat サーバーに access_token の更新を要求し、他のスレッドは操作を実行せずにすぐに戻ります。
access_token アクセス ポリシーの問題
  • Web アプリケーションのスタンドアロン展開: アプリケーションがスタンドアロン マシンに展開されている場合は、デフォルトのポリシーを直接使用して、access_token をメモリに保存できます。
  • Web アプリケーション クラスターのデプロイメント: アプリケーションがクラスターにデプロイされている場合は、独自の access_token アクセス戦略を実装し、access_token をクラスター共有メディア (データベースなど) に保存して、access_token の集中制御と管理を実現する必要があります。独自の戦略クラスを実装した後、wechat-mp.properties に設定accessTokenStrategyClass=your.package.name.YourAccessTokenStrategyを追加します。以下は、accesss_token データベースにアクセスするための戦略です。 
 import space . chensheng . wechatty . common . http . AccessTokenStrategy ;

//因为这个策略类的实例化不是通过Spring来管理的，所以在这个类中不能使用Autowired来注入bean，
//要通过ApplicationContext#getBean方法来获取。
public class DatabaseAccessTokenStrategy implements AccessTokenStrategy {
	
    //将access_token存到数据库中去
    @ Override
    public void doSave ( String accessToken ) {
        TokenService tokenService = ApplicationContextUtil
	    . getApplicationContext (). getBean ( TokenService . class );
	tokenService . doSave ( accessToken );
    }
    
    //从数据库中取出access_token
    @ Override
    public String doQuery () {
        TokenService tokenService = ApplicationContextUtil
	    . getApplicationContext (). getBean ( TokenService . class );
	return tokenService . doQuery ();
    }
}

メッセージを受信する

MpAppContextが初期化されたら、メッセージを受信するためにWechatMpBootstrapを通じてメッセージ リスナーを追加します (メッセージ リスナーは後で紹介します)。 

 WechatMpBootstrap bootstrap = new WechatMpBootstrap();
bootstrap.addMsgListener(new TextMessageListener());
bootstrap.addMsgListener(new SubscribeEventListener());
bootstrap.addMsgListener(new UnsubscribeEventListener());
WeChat サーバーのオープン コールバック リクエストを確認する

WeChat 公式アカウントのバックグラウンドでコールバック URL を設定した場合、WeChat サーバーは検証のためにこの URL に GET リクエストを送信します。開発者はこのリクエストを Web アプリケーションで処理する必要があります。以下は SpringMVC の検証例です。 

 @RestController
@RequestMapping(value = "/wechat-mp")
public class CallbackController extends BaseController{

    @Autowired
    private MpAppContext mpAppContext;
    
    //验证请求，并回复字符串
    @RequestMapping(value = "/callback", method = RequestMethod.GET)
    public String verify(String msg_signature, String timestamp, String nonce, String echostr) {
        String reply = mpAppContext.getCallbackModeVerifier().verify(msg_signature, timestamp, nonce, echostr);
	return reply;
    }
    
}
メッセージコールバックリクエストの処理

コールバック リクエストを確認した後、コールバック モードが実際に有効になります。ユーザーが公式アカウントにメッセージを送信すると、WeChat サーバーはコールバック URL に POST リクエストを送信し、開発者はこのリクエストを Web アプリケーションで処理する必要があります。以下は SpringMVC の例です。 (およびコントローラーでコールバックを有効にする以前の検証例): 

 @RestController
@RequestMapping(value = "/wechat-mp")
public class CallbackController extends BaseController{

    @Autowired
    private MpAppContext mpAppContext;
    
    //接收回调消息，并回复相应xml消息
    @RequestMapping(value = "/callback", method = RequestMethod.POST)
    public String verify(String msg_signature, String timestamp, String nonce) {
        //postBody是请求体内容，String格式，开发者可以通过HttpServletRequest来解析
        String replyXml = mpAppContext.getMpMessageDispatcher().dispatch(msg_signature(), timestamp, nonce, postBody);
	return replyXml;
    }
}
コールバックメッセージの監視

開発者は、 space.chensheng.wechatty.common.message.MessageListenerを継承することで、特定の種類のメッセージをリッスンできます。ユーザーが送信したテキスト メッセージを聞く例を次に示します。 

 public class TextMessageListener extends MessageListener<TextInboundMessage> {

    @Override
    protected ReplyMessage onMessage(TextInboundMessage message) {
        String content = message.getContent();
	
	//根据消息内容来回复用户
	if ("1".equals(content)) {
	    TextReplyMessage replyMsg = new TextReplyMessage();
	    replyMsg.setContent("this is reply message content");
	    replyMsg.setFromUserName(message.getToUserName());
	    replyMsg.setToUserName(message.getFromUserName());
	    replyMsg.setCreateTime(System.currentTimeMillis());
	    return replyMsg;
	}
	
	//返回null表示不回复用户
	return null;
    }
}
監視できるメッセージの種類
情報説明する
テキスト受信メッセージテキストメッセージ
画像受信メッセージ絵メッセージ
リンクインバウンドメッセージグラフィックメッセージへジャンプ
位置受信メッセージ位置情報を共有する
ショートビデオインバウンドメッセージ小さなビデオメッセージ
ビデオインバウンドメッセージビデオメッセージ
音声インバウンドメッセージ音声メッセージ
クリックイベントメッセージ通常メニューのメッセージをクリックします
イベントメッセージの表示クリックするとリンクメニューメッセージにジャンプします
場所イベントメッセージロケーションイベントメッセージ
購読イベントメッセージユーザーは公開アカウントのニュースをフォローします
購読解除イベントメッセージ公開アカウントのメッセージのフォローを忘れずに解除してください
スキャンイベントメッセージユーザーが QR コード メッセージをスキャンする
MassSendJobFinishEventMessageグループメッセージ送信完了報告
返信可能なメッセージの種類
情報説明する
テキスト返信メッセージテキスト返信
画像返信メッセージ画像返信
音楽返信メッセージ音楽の返信
ニュース返信メッセージグラフィック返信
ビデオ返信メッセージビデオ返信
音声応答メッセージ音声応答

メッセージを送信する

公式アカウントは、グループ メッセージやカスタマー サービス メッセージなどのメッセージをユーザーに積極的に送信できます。すべてのメッセージは、 space.chensheng.wechatty.mp.message.MpMessageSenderを使用して均一に送信されます。

グループメッセージ
 TextMassMessage message = new TextMassMessage();
message.setIsToAll(true);
message.setContent("群发消息测试");
mpAppContext.getMpMessageSender().send(message, 3);
グループメッセージの種類説明する
テキスト大量メッセージバルクテキスト
画像大量メッセージ画像グループ送信
MPニュースマスメッセージWeChat内での写真やテキストのグループ送信
MpvideoMassMessageビデオグループ送信
ボイスマスメッセージ音声グループ送信
WxcardMassMessage WeChatカードとクーポンの大量配布
カスタマーサービスメッセージ
 TextCsMessage message = new TextCsMessage();
message.setToUser("thisIsUserOpenId");
message.setContent("客服消息测试 n 212");
mpAppContext.getMpMessageSender().send(message, 3);
カスタマーサービスのメッセージタイプ説明する
TextCsMessageテキストカスタマーサービス
画像Csメッセージ画像のカスタマーサービス
MPニュースCsメッセージWeChat内でのグラフィックカスタマーサービス
ニュースCsメッセージ外部グラフィックカスタマーサービス
ビデオCSメッセージビデオカスタマーサービス
VoiceCsメッセージ音声カスタマーサービス
WxcardCsメッセージWeChat カードおよびバウチャーのカスタマー サービス

資材管理

マテリアル管理には主に、マテリアルのアップロード、クエリ、変更、削除が含まれます。マテリアルの種類には、写真、ビデオ、音声、グラフィックが含まれます。

素材をアップロードする

素材のアップロードは、対応する素材アップロードクラスを操作することで完了します。 画像をアップロードする例は次のとおりです。 

 File image = new File("/this/is/image/path.jpg");
ImagePermanentMedia material = new ImagePermanentMedia(mpAppContext, image);
UploadResponse resp = material.upload();
素材アップロードクラス説明する
画像永久メディア永久写真
親指永久メディア永久サムネイル
ビデオ永久メディア永久ビデオ
音声永久メディア永久音声
常設ニュース永続的な写真とテキスト
常設ニュース画像永久グラフィックスの写真
画像一時メディア一時的な画像
親指一時的なメディア一時的なサムネイル
ビデオ一時メディア一時的なビデオ
音声一時メディア一時的な音声
クエリ資料

マテリアル クエリ操作は、ツール クラスspace.chensheng.wechatty.mp.material.MaterialQueryおよびspace.chensheng.wechatty.mp.material.MaterialFinderを通じて完了します。

  • 材料の数量情報をクエリ: mpAppContext.getMaterialQuery().count()
  • グラフィック素材のクエリ: mpAppContext.getMaterialQuery().listNews(int offset, int count)
  • 他のマテリアルのクエリ: mpAppContext.getMaterialQuery().listMedia(MediaType mediaType, int offset, int count)
  • mediaId に基づいて画像とテキストを検索します: mpAppContext.getMaterialFinder().findNews(String mediaId)
  • mediaId に基づいて永久ビデオを検索: mpAppContext.getMaterialFinder().findPermanentVideo(String mediaId)
  • mediaId に基づいて一時ビデオを検索します: mpAppContext.getMaterialFinder().findTemporaryVideo(String mediaId)
  • mediaId に基づいて永久マテリアルをダウンロードします: mpAppContext.getMaterialFinder().downloadPermanentMedia(String mediaId, String saveDir, String fileName)
  • mediaId に基づいて一時マテリアルをダウンロードします: mpAppContext.getMaterialFinder().downloadTemporaryMedia(String mediaId, String saveDir, String fileName)
素材の削除

マテリアルの削除操作は、ツール クラスspace.chensheng.wechatty.mp.material.MaterialDeleterを通じて完了します。

  • mediaId に基づいてマテリアルを削除します: mpAppContext.getMaterialDeleter().delete(String mediaId)

アカウント管理

パラメータを使用して QR コードを生成する

パラメーターを使用した QR コードの生成は、ツール クラスspace.chensheng.wechatty.mp.account.QRCodeCreatorを通じて完了します。

  • パラメーターを使用して一時的な QR コードを生成します: mpAppContext.getQRCodeCreator().createTemporary(int expireSeconds, int sceneId)
  • 整数パラメータを使用して永続的な QR コードを生成します: mpAppContext.getQRCodeCreator().createPermanent(int sceneId)
  • 文字列パラメーターを使用して永続的な QR コードを生成します: mpAppContext.getQRCodeCreator().createPermanent(String sceneStr)
ユーザー情報を問い合わせる

ユーザー情報のクエリは、 UserInfoQueryを通じて実装されます。

  • 単一ユーザー情報のクエリ: mpAppConext.getUserInfoQuery().get(String openId)
  • ユーザー情報をバッチでクエリします: mpAppContext.getUserInfoQuery().batchGet(List<String> openIds)

WeChatの認証

ユーザー認証

ユーザー認証はAuthHelperを通じて実装されます。

  • 認証リンク コード: mpAppContext.getAuthHelper().fetchAuthAccessToken(String code)を通じてauth access tokenを取得します。
  • auth access tokenの更新: mpAppContext.getAuthHelper().refreshAuthAccessToken(String refreshAccessToken)
  • auth access tokenを通じてユーザー情報を取得します: mpAppContext.getAuthHelper().fetchAuthUserInfo(String authAccessToken, String openId)

以下はユーザー認証の疑似コードです。 

 public WxAuthLoginDto authAndLogin(String code) {
    AuthAccessTokenResponse authResp = mpAppContext.getAuthHelper().fetchAuthAccessToken(code);
    if (authResp == null || !authResp.isOk()) {
        //授权失败，执行相应业务逻辑
        return new WxAuthLoginDto("fail");
    }
		
    String openId = authResp.getOpenId();
    AuthUserInfoResponse wxUserInfo = mpAppContext.getAuthHelper().fetchAuthUserInfo(authResp.getAccessToken(), authResp.getOpenId())
    //根据微信用户信息在数据库里查找系统对应的用户，或新建一个用户
    
    //进行登录相关业务逻辑处理
    return new WxAuthLoginDto("success");
}
jsapi認証

jsapi 認可はJsapiHelperを通じて実装されます。

  • jsapi ticketを取得します (スケジュールされたタスクを使用してチケットを定期的に取得し、データベースに保存できます): mpAppContext.getJsapiHelper().fetchTicket()
  • jsapi 署名情報を生成します: mpAppContext.getJsapiHelper().generateSignature(String jsapiTicket, String nonceStr, long timestamp, String url)

ウィーチャットペイ

MpAppContext初期化するときに、 WechatMpBootstrapのenablePayCert()メソッドを呼び出して WeChat 支払いを有効にし、関連パラメーターを構成します。 (特定のパラメータについては構成モジュールを参照してください) 

 WechatMpBootstrap bootstrap = new WechatMpBootstrap();
bootstrap.enablePayCert();
  • 通常の赤い封筒を送信します: mpAppContext.getPayHelper().sendRedPack(RedPackRequest request)
  • グループの赤い封筒を送信します: mpAppContext.getPayHelper().sendGroupRedPack(GroupRedPackRequest request)
  • 転送: mpAppContext.getPayHelper().transfers(TransfersRequest request)
  • 前払い注文の生成: mpAppContext.getPayHelper().unifiedOrder(UnifiedOrderRequest request)
  • 支払いコールバックを解析します: mpAppContext.getPayHelper().parsePayNotify(String notifyContent)
  • 検証支払いコールバック: mpAppContext.getPayHelper().validatePayNotify(PayNotifyResponse response)
  • 支払い注文クエリ: mpAppContext.getPayHelper().orderQuery(OrderQueryRequest request)
  • 支払い注文のクローズ: mpAppContext.getPayHelper().closeOrder(CloseOrderRequest request)
  • 短いリンクを生成します: mpAppContext.getPayHelper().shortUrl(String longUrl)
  • js 支払いパラメーターを生成します: mpAppContext.getPayHelper().generateJsapiPayParams(String prepayId, PaySignType signType)
  • 払い戻しを開始します: mpAppContext.getPayHelper().refund(RefundRequest request)
  • 払い戻しコールバックを解析します: mpAppContext.getPayHelper().parseRefundNotify(String notifyContent)
拡大する
追加情報
関連アプリ
おすすめ
関連情報 すべて