# ok-wx

**Repository Path**: e-starter/ok-wx

## Basic Information

- **Project Name**: ok-wx
- **Description**: 开源高效快速微信开发
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 14
- **Forks**: 0
- **Created**: 2020-10-10
- **Last Updated**: 2025-08-18

## Categories & Tags

**Categories**: weixin-dev

**Tags**: None

## README

# ok-calls Weixin 极速开发
ok-calls Weixin 是基于 开源的[jfinal-weixin] 项目，作者认为该项目 太多历史代码不符合阿里规约、设计老旧且存在一些不合理的设计，在此前提下对该项目进行重构，本框架可以公众号极速开发 SDK，只需浏览 Demo 代码即可进行极速开发。

- 简化微信配置，启动检测
- 简化微信api对接
- 罗列了大部分微信回调事件，使用框架可以自己重写回调实现逻辑【继承 WxWxMsgDefaultDispatcher，重写你想要实现的事件】
- 直接提供了签名、校验等api

- pom中版管理可以移步到 https://gitee.com/e-starter/estart-dependencies 中

# 快速使用
示例工程见本项目内 ok-wx-demo

## 0、 maven 坐标
```xml
  		<dependency>
            <groupId>com.noriental</groupId>
            <artifactId>ok-wx-core</artifactId>
            <version>0.1-SNAPSHOT</version>
        </dependency>
```

## 1、WeixinConfig配置
`详情DEMO用例请见`：com.noriental.okcalls.config.CustomWxConfig

- WxWxMsgDefaultDispatcher 请自己实现对应的事件接收后编码工作，demo中的默认dispatcher仅为打印回调消息

```java
  @PostConstruct
    public void afterPropertiesSet() throws Exception {
        log.info("start loading");

        ApiConfig wxConfig = new ApiConfig();
        WxApiConfigInstance.devMode = false;
        wxConfig.setAppId("wx5f0e1f1c8446efaf");
        wxConfig.setAppSecret("ef0488561ee140d7c8b507da7b30a84b");
        wxConfig.setEncodingAesKey("");
        wxConfig.setToken("");
        wxConfig.setEncryptMessage(false);
        WxApiConfigInstance.apiConfig = wxConfig;

        log.info("wxConfig is {}", JSON.toJSONString(WxApiConfigInstance.apiConfig));

    }

 WxMsgDispatchCenter demoDispatchCenter() {
        log.info("start loading custom dispatch center");

        WxMsgDispatchCenter wxMsgDispatchCenter = new WxMsgDispatchCenter();
        wxMsgDispatchCenter.setWxMsgDispatcher(new WxWxMsgDefaultDispatcher());
        return wxMsgDispatchCenter;
    }
```



## 2、CallbackController

`微信回调demo 见`com.noriental.okcalls.controller.WxCallbackController

``` java
@PostMapping(value = "/callBack")
    public String recMsg(@RequestBody String xml, HttpServletRequest req) {
        String s = req.getParameter("s");
        log.info("msg is  {},security is {}", JSONObject.toJSONString(MsgAdapter.analysisMsg(xml)), s);
        demoDispatchCenter.dispatch(xml);
        return "ok";
    }
```
## 3、PayController
`微信支付H5 见` com.noriental.okcalls.controller.WxPayController

``` java
详见源代码 com/noriental/okcalls/controller/WxPayController.java:42
```
通过调用 MenuApi、UserApi 等 Api 的相关方法即可获取封装成 ApiResult 对象的结果，使用 render 系列方法即可快捷输出结果

## 4、 微信api

`微信api demo见`com/noriental/okcalls/test/TestWechatApi.java:28


## 5、WIKI持续更新中
WIKI：https://gitee.com/e-starter/ok-wx/wikis
欢迎更多同学来帮助完善！

## 6､ 开发调试环境搭建
待补充

## 7、更多支持
- 待补充