wechat core

wechat-core

一款轻量级的微信消息处理框架,可以让业务代码与微信微信处理框架代码解耦,并且你根本不需要关心消息是如何发送的,你只需要关注你的业务即可.

Project introduction

1. It encapsulates WeChat message receiving and sending, and can use annotation-driven development to facilitate business development without having to pay attention to the details of message receiving and message sending.

2. The message processor abstract class is encapsulated internally, which provides functions such as message filtering before processing messages, default behavior logs, etc. Users can inherit this class to implement their own business.

3. Just add annotations to separate the message processors that process each type. It also supports separating message processors for different event types, avoiding the need to use large sections of if elseif elseif to determine the type of messages in the code that handles business logic. way. The responsibilities of each interface are clear and the implementation is more decoupled;

Things to note

• Many people ask me if the code of the project is incomplete? Why do cloned codes always report errors? Because I use the lombok plug-in in the project, if the IDE (idea, eclipse) does not install this plug-in, an error may be reported. So you need to install and configure the plug-in in advance.

Introduction to the technologies used

1. It uses jdk 1.8, lombok plug-in, integrates springMVC and maven 3.0+, uses a small amount of lambda expressions, does not use any advanced technology, and the comments in the code are also very detailed. I believe readers can easily understand it.

Project structure analysis

Quick start (excluding WeChat public platform application and interface URL, token and other configuration steps)

1. Create a wechat.properties property file in the root path of the classpath and configure wechat.appId, wechat.appsecret, wechat.token, and wechat.encodingAESKey ( the name must be the same as this ). The example is as follows:

2. Write a message processor class, inherit the AbstractMessageHandler abstract class, implement the doHandleMessage method, add the @MessageProcessor annotation on the class, and specify the message type to be processed. The attribute messageType specifies the message type to be processed, and eventType specifies the event type to be processed. . When the message type is a normal message, the eventType attribute does not need to be specified (even if specified, it will be invalid). The sample code is as follows:

   • Processing of basic message types (text message processor)

    @ Component
   @ MessageProcessor ( messageType = MessageType . TEXT_MESSAGE )    
   public class TextMessageHandlerExample extends AbstractMessageHandler {    
       private static final Logger LOGGER = LoggerFactory . getLogger ( TextMessageHandlerExample . class );    
   
       public BaseResponseMessage doHandleMessage ( BaseRequestMessage requestMessage ) {    
               //在这里实现你自己的业务逻辑    
           TextRequestMessage textRequestMessage = ( TextRequestMessage ) baseRequestMessage ;
           return MessageUtils . buildTextResponseMessage ( baseRequestMessage , textRequestMessage . getContent ());     
       }    
   }    

   • Pay attention to message processing of event types

    @ Component
   @ MessageProcessor ( messageType = MessageType . EVENT , eventType = EventType . EVENT_SUBSCRIBE )    
   public class SubscribeEventMessageHandlerExample extends AbstractMessageHandler {    
   
       private static final Logger LOGGER = LoggerFactory . getLogger ( SubscribeEventMessageHandlerExample . class );
          
       @ Override
       public BaseResponseMessage doHandleMessage ( BaseRequestMessage baseRequestMessage ) {
           SubOrUnSubEventRequestMessage subOrUnSubEventRequestMessage = ( SubOrUnSubEventRequestMessage ) baseRequestMessage ;
        //在这里实现你自己的业务逻辑
       }
   }

3. just run your application!! have fun...

Sample code

The sample code links for receiving and replying to various message types are as follows for readers’ reference.

• Basic message types

  • Text message processor sample code
  • Image message processor sample code
  • Link message handler sample code
  • Voice message processing sample code
  • Short video message processing sample code
  • Video message processing sample code
  • Geolocation message processing sample code

• Event message type

  • Follow the event message handler sample code
  • Unfollow event message handler sample code
  • Upload geolocation event message processor sample code
  • Scan QR code event message handler sample code
  • Custom menu jump event message processor sample code
  • Custom menu click event message handler sample code
  • Scan code push event message processor sample code
  • Sample code for an event message handler that scans the QR code to push an event and pops up the "Message Receiving" prompt box

Effect demonstration

Scan the QR code below and follow the official account to experience the function

List of implemented features

1. Reception and response to basic message types (text, pictures, audio, video, location, short video, link message) and event messages (follow, unfollow, upload geographical location, scan QR code and custom menu event messages) Encapsulation.
2. For the encapsulation of access_token, please refer to AccessTokenService.
3. For encapsulation of the entire user interface API, please refer to WechatUserService

Contact the author

Email: [email protected], bugs and suggestions are welcome.

Looking for a job

Online resume: https://151376liujie.github.io/resume/