Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dadiyang/wechat-client
Mojo-Weixin的 Java 客户端
https://github.com/dadiyang/wechat-client
Last synced: 2 months ago
JSON representation
Mojo-Weixin的 Java 客户端
- Host: GitHub
- URL: https://github.com/dadiyang/wechat-client
- Owner: dadiyang
- License: mit
- Created: 2019-01-07T05:03:47.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-07T05:53:30.000Z (about 6 years ago)
- Last Synced: 2023-06-30T14:04:55.003Z (over 1 year ago)
- Language: Java
- Size: 40 KB
- Stars: 13
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 微信Java客户端
[Mojo-Weixin](https://github.com/sjdy521/Mojo-Weixin) [HTTP 接口](https://github.com/sjdy521/Mojo-Weixin/blob/master/API.md) 的 Java 客户端
# 接口列表汇总
本项目使用 [http-api-invoker](https://github.com/dadiyang/http-api-invoker) 框架实现，提供以下方法:
| 接口类 | 方法 | 功能 |
| ----- | ----- | ----- |
| *ClientApi* | |对 Mojo-Weixin 进程的操作|
|ClientApi|getClientInfo|获取进程运行信息|
|ClientApi|stopClient|终止客户端运行|
|ClientApi|startClient|启动一个客户端|
|ClientApi|getQrcode|获取登录二维码文件|
| *FriendApi* | | 微信好友相关的操作|
|FriendApi| searchFriend | 搜索好友对象|
|FriendApi| getFriendInfo | 获取好友信息|
|FriendApi| getAvatar | 获取用户头像|
|FriendApi| setMarkname | 修改好友或群成员备注名称|
|FriendApi| stick | 设置或取消群组、好友置顶|
|FriendApi| makeFriend | 向指定的群成员发送好友请求|
|FriendApi| acceptFriendRequest | 接受好友验证申请|
| *GroupApi* | | 用于微信群相关的操作 |
|GroupApi| searchGroup | 搜索群组对象 |
|GroupApi| getGroupInfo | 获取群组数据 |
|GroupApi| getGroupBasicInfo | 获取群组基本数据 |
|GroupApi| getAvatar | 获取群组头像 |
|GroupApi| createCroup | 创建群组 |
|GroupApi| inviteFriend | 邀请好友入群 |
|GroupApi| kickGroupMember| 移除群组成员 |
|GroupApi| setGroupDisplayname| 设置群组的显示名称 |
| *MediaApi* | |媒体相关操作|
|MediaApi| uploadMedia |上传媒体文件，获取media_id|
| *MessageApi* | |消息相关操作|
|MessageApi| revokeMessage |撤回消息|
|MessageApi| sendFriendMessage |发送好友消息|
|MessageApi| sendGroupMessage |发送群消息|
|MessageApi| consult |发送消息给好友并等待好友回答|
具体方法参数含义及使用说明，请查看具体类的代码注释或查看 [接口文档](https://github.com/sjdy521/Mojo-Weixin/blob/master/API.md)
# 使用
## 一、引入 maven 依赖
```xml
com.github.dadiyang
wechat-client
1.0.1
```
## 二、设置微信服务地址
通过系统参数设置 Mojo-Weixin 的服务地址
```java
System.setProperty("wechat.host", "http://localhost:3000");
```
## 三、获取Api对象
### Spring项目
在Spring的项目中，只需要在ComponentScan中添加 `com.github.dadiyang.wechat.spring` 即可使用@AutoWired获取api接口的实现类，即
```java
@ComponentScan(basePackages = {"com.github.dadiyang.wechat.spring"})
public class Application {
}
```
然后就可以在需要使用的地方使用 @Autowired 注解了:
```java
@Autowired
private ClientApi clientApi;
@Autowired
private FriendApi friendApi;
@Autowired
private GroupApi groupApi;
@Autowired
private MediaApi mediaApi;
@Autowired
private MessageApi messageApi;
@Autowired
private UserApi userApi;
```
### 普通项目
非 Spring 项目需要自己调用工厂方法获取:
```java
HttpApiProxyFactory factory = new HttpApiProxyFactory();
FriendApi friendApi = factory.getProxy(FriendApi.class);
GroupApi groupApi = factory.getProxy(GroupApi.class);
```