wechat spring boot starter
修复一些杂项问题
Компоненты, связанные с WeChat, все еще совершенствуются. Спасибо JetBrains за признание этого проекта. Адрес проекта: https://github.com/lcy19930619/wechat-spring-boot-starter.
Адрес вики: https://github.com/lcy19930619/wechat-spring-boot-starter/wiki.
Некоторые вещи, написанные в документах WeChat, кажутся немного беспорядочными, и многие вещи нужно найти и поискать. Возможность повторного использования кода Baidu, csdn и т. д. не высока, поэтому я написал этот компонент в надежде на большую универсальность. .
Включите его через файл конфигурации. После включения информация будет зашифрована и расшифрована. Вам необходимо установить метод шифрования и дешифрования сообщений в фоновом режиме WeChat --- Базовая конфигурация --- Конфигурация сервера как: Безопасный режим.
<dependencyManagement>
<dependencies>
<dependency>
<groupId>net.jlxxw</groupId>
<artifactId>wechat-spring-boot-starter</artifactId>
<version>${最新版本请查看仓库}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
< dependency >
< groupId >net.jlxxw</ groupId >
< artifactId >wechat-event-netty-spring-boot-starter</ artifactId >
</ dependency >< dependency >
< groupId >net.jlxxw</ groupId >
< artifactId >wechat-event-web-spring-boot-starter</ artifactId >
</ dependency >шаг:
@ComponentПример кода выглядит следующим образом:
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 ( "回复用户一个文本信息" );
}
}шаг:
@Component . Пример кода выглядит следующим образом: 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" );
}
}Применимые сценарии:
< 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 ));
}
}< dependency >
< groupId >net.jlxxw</ groupId >
< artifactId >wechat-repository-mysql-spring-boot-starter</ artifactId >
</ dependency >шаг:
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 ;
}
}< 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 >< dependency >
< groupId >net.jlxxw</ groupId >
< artifactId >wechat-common</ artifactId >
</ dependency >< dependency >
< groupId >net.jlxxw</ groupId >
< artifactId >wechat-event</ artifactId >
</ dependency >< dependency >
< groupId >net.jlxxw</ groupId >
< artifactId >wechat-event</ artifactId >
</ dependency > 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 запрашивает данные, ищет и регистрирует их в ioc-контейнере по событию и MsgType слушателю (то есть написанному вами бизнес-слушателю)
6. Вызовите метод-обработчик прослушивателя для выполнения связанных сервисов.
7. Верните данные на сервер WeChat.
1. wechat-event-web-spring-boot-starter инициализируется при запуске системы и регистрирует WeChatMessageController как вход в программу. 2. Запросы данных WeChat отправляются в WeChatMessageController, и выполняется аутентификация по белому списку. 3. Перенаправить запрос в EventBus.
4. Разбираем данные запроса WeChat, находим прописанный в ioc-контейнере слушатель по событию и MsgType (то есть написанный вами бизнес-слушатель)
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
