cyonjan/WeChatFerry
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(0): [java]-[wechat-ferry-mvn]-代码规范完善

Browse Source
This commit is contained in:
chandler 2024-10-01 12:32:26 +08:00
parent cca9d1f52c
commit ca6a8e9602
6 changed files with 50 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
clients/java/wechat-ferry-mvn/README.MD vendored
View File

@ -2,6 +2,9 @@
⚠️ **只支持 Windows** ⚠️
`声明：` 本项目是基于 clients/java/wcferry 项目改造，随着时间推进，项目结构和代码规范逐渐产生分离，使用此项目的人员可参考之前的项目
我们在开发时请尽量保持注释的完整性，便于阅读维护
## 快速使用
### 环境准备
@ -38,11 +41,12 @@
```yaml
# 本服务参数
wcferry:
# DLL文件位置
dll-path: E:\WeChatFerry\clients\java\wechat-ferry-mvn\dll\sdk.dll
# socket端口
socket-port: 10086
wechat:
ferry:
# DLL文件位置
dll-path: E:\WeChatFerry\clients\java\wechat-ferry-mvn\dll\sdk.dll
# socket端口
socket-port: 10086
```
### 编译运行

10
clients/java/wechat-ferry-mvn/src/main/java/com/wechat/ferry/config/WechatConfiguration.java → clients/java/wechat-ferry-mvn/src/main/java/com/wechat/ferry/config/WeChatConfiguration.java vendored
View File

@ -5,7 +5,7 @@ import javax.annotation.Resource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.wechat.ferry.handle.WechatSocketClient;
import com.wechat.ferry.handle.WeChatSocketClient;
import lombok.extern.slf4j.Slf4j;
@ -17,21 +17,21 @@ import lombok.extern.slf4j.Slf4j;
*/
@Slf4j
@Configuration
public class WechatConfiguration {
public class WeChatConfiguration {
@Resource
private WeChatFerryProperties properties;
@Bean
public WechatSocketClient client() {
log.debug("测试：端口：{}，地址：{}", properties.getSocketPort(), properties.getDllPath());
public WeChatSocketClient client() {
log.debug("[读取配置文件]-端口：{}，地址：{}", properties.getSocketPort(), properties.getDllPath());
// 连接远程 RPC
// Client client = new Client("127.0.0.1", 10086);
// 本地启动 RPC
// Client client = new Client(); // 默认 10086 端口
// Client client = new Client(10088,true); // 也可以指定端口
WechatSocketClient wechatSocketClient = new WechatSocketClient(properties.getSocketPort(), properties.getDllPath());
WeChatSocketClient wechatSocketClient = new WeChatSocketClient(properties.getSocketPort(), properties.getDllPath());
// 是否已登录
// log.info("isLogin: {}", client.isLogin());

6
clients/java/wechat-ferry-mvn/src/main/java/com/wechat/ferry/controller/TestController.java vendored
View File

@ -12,6 +12,12 @@ import com.wechat.ferry.service.TestService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
/**
* 控制层-测试类
*
* @author chandler
* @date 2024-09-25 22:17
*/
@RestController
@RequestMapping("/test")
@Api(tags = "测试-接口")

46
clients/java/wechat-ferry-mvn/src/main/java/com/wechat/ferry/handle/WechatSocketClient.java → clients/java/wechat-ferry-mvn/src/main/java/com/wechat/ferry/handle/WeChatSocketClient.java vendored
View File

@ -8,10 +8,8 @@ import java.util.Map;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.BlockingQueue;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.alibaba.fastjson2.JSONObject;
import com.sun.jna.Native;
import com.wechat.ferry.entity.po.Wcf;
import com.wechat.ferry.entity.po.Wcf.DbQuery;
import com.wechat.ferry.entity.po.Wcf.DbRow;
@ -27,16 +25,20 @@ import com.wechat.ferry.entity.po.Wcf.Verification;
import com.wechat.ferry.entity.po.Wcf.WxMsg;
import com.wechat.ferry.entity.vo.response.WxMsgResp;
import com.wechat.ferry.service.SDK;
import com.sun.jna.Native;
import io.sisu.nng.Socket;
import io.sisu.nng.pair.Pair1Socket;
import lombok.extern.slf4j.Slf4j;
/**
* 处理层-微信客户端
*
* @author Changhua
* @date 2023-12-06 22:11
*/
@Slf4j
public class WechatSocketClient {
public class WeChatSocketClient {
private static final Logger logger = LoggerFactory.getLogger(WechatSocketClient.class);
private static final int BUFFER_SIZE = 16 * 1024 * 1024; // 16M
private Socket cmdSocket = null;
private Socket msgSocket = null;
@ -52,15 +54,15 @@ public class WechatSocketClient {
private int port;
private String dllPath;
public WechatSocketClient() {
public WeChatSocketClient() {
this(DEFAULT_HOST, PORT, false, DEFAULT_DLL_PATH);
}
public WechatSocketClient(int port, String dllPath) {
public WeChatSocketClient(int port, String dllPath) {
this(DEFAULT_HOST, port, false, dllPath);
}
public WechatSocketClient(String host, int port, boolean debug, String dllPath) {
public WeChatSocketClient(String host, int port, boolean debug, String dllPath) {
this.host = host;
this.port = port;
this.dllPath = dllPath;
@ -68,7 +70,7 @@ public class WechatSocketClient {
SDK INSTANCE = Native.load(dllPath, SDK.class);
int status = INSTANCE.WxInitSDK(debug, port);
if (status != 0) {
logger.error("启动 RPC 失败: {}", status);
log.error("启动 RPC 失败: {}", status);
System.exit(-1);
}
connectRPC(String.format(CMDURL, host, port), INSTANCE);
@ -87,11 +89,11 @@ public class WechatSocketClient {
waitMs(1000);
}
} catch (Exception e) {
logger.error("连接 RPC 失败: ", e);
log.error("连接 RPC 失败: ", e);
System.exit(-1);
}
Runtime.getRuntime().addShutdownHook(new Thread(() -> {
logger.info("关闭...");
log.info("关闭...");
diableRecvMsg();
if (isLocalHostPort) {
INSTANCE.WxDestroySDK();
@ -107,7 +109,7 @@ public class WechatSocketClient {
long size = cmdSocket.receive(ret, true);
return Response.parseFrom(Arrays.copyOfRange(ret.array(), 0, (int)size));
} catch (Exception e) {
logger.error("命令调用失败: ", e);
log.error("命令调用失败: ", e);
return null;
}
}
@ -242,7 +244,7 @@ public class WechatSocketClient {
public int sendText(String msg, String receiver, String aters) {
Wcf.TextMsg textMsg = Wcf.TextMsg.newBuilder().setMsg(msg).setReceiver(receiver).setAters(aters).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_TXT_VALUE).setTxt(textMsg).build();
logger.debug("sendText: {}", bytesToHex(req.toByteArray()));
log.debug("sendText: {}", bytesToHex(req.toByteArray()));
Response rsp = sendCmd(req);
int ret = -1;
if (rsp != null) {
@ -262,7 +264,7 @@ public class WechatSocketClient {
public int sendImage(String path, String receiver) {
Wcf.PathMsg pathMsg = Wcf.PathMsg.newBuilder().setPath(path).setReceiver(receiver).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_IMG_VALUE).setFile(pathMsg).build();
logger.debug("sendImage: {}", bytesToHex(req.toByteArray()));
log.debug("sendImage: {}", bytesToHex(req.toByteArray()));
Response rsp = sendCmd(req);
int ret = -1;
if (rsp != null) {
@ -282,7 +284,7 @@ public class WechatSocketClient {
public int sendFile(String path, String receiver) {
Wcf.PathMsg pathMsg = Wcf.PathMsg.newBuilder().setPath(path).setReceiver(receiver).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_FILE_VALUE).setFile(pathMsg).build();
logger.debug("sendFile: {}", bytesToHex(req.toByteArray()));
log.debug("sendFile: {}", bytesToHex(req.toByteArray()));
Response rsp = sendCmd(req);
int ret = -1;
if (rsp != null) {
@ -304,7 +306,7 @@ public class WechatSocketClient {
public int sendXml(String receiver, String xml, String path, int type) {
Wcf.XmlMsg xmlMsg = Wcf.XmlMsg.newBuilder().setContent(xml).setReceiver(receiver).setPath(path).setType(type).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_XML_VALUE).setXml(xmlMsg).build();
logger.debug("sendXml: {}", bytesToHex(req.toByteArray()));
log.debug("sendXml: {}", bytesToHex(req.toByteArray()));
Response rsp = sendCmd(req);
int ret = -1;
if (rsp != null) {
@ -324,7 +326,7 @@ public class WechatSocketClient {
public int sendEmotion(String path, String receiver) {
Wcf.PathMsg pathMsg = Wcf.PathMsg.newBuilder().setPath(path).setReceiver(receiver).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_EMOTION_VALUE).setFile(pathMsg).build();
logger.debug("sendEmotion: {}", bytesToHex(req.toByteArray()));
log.debug("sendEmotion: {}", bytesToHex(req.toByteArray()));
Response rsp = sendCmd(req);
int ret = -1;
if (rsp != null) {
@ -437,7 +439,7 @@ public class WechatSocketClient {
msgSocket.dial(url);
msgSocket.setReceiveTimeout(2000); // 2 秒超时
} catch (Exception e) {
logger.error("创建消息 RPC 失败", e);
log.error("创建消息 RPC 失败", e);
return;
}
ByteBuffer bb = ByteBuffer.allocate(BUFFER_SIZE);
@ -453,7 +455,7 @@ public class WechatSocketClient {
try {
msgSocket.close();
} catch (Exception e) {
logger.error("关闭连接失败", e);
log.error("关闭连接失败", e);
}
}
@ -465,7 +467,7 @@ public class WechatSocketClient {
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_ENABLE_RECV_TXT_VALUE).build();
Response rsp = sendCmd(req);
if (rsp == null) {
logger.error("启动消息接收失败");
log.error("启动消息接收失败");
isReceivingMsg = false;
return;
}
@ -514,7 +516,7 @@ public class WechatSocketClient {
gender = "未知";
}
logger.info("{}, {}, {}, {}, {}, {}, {}", c.getWxid(), c.getName(), c.getCode(), c.getCountry(), c.getProvince(), c.getCity(), gender);
log.info("{}, {}, {}, {}, {}, {}, {}", c.getWxid(), c.getName(), c.getCode(), c.getCountry(), c.getProvince(), c.getCity(), gender);
}
}

6
clients/java/wechat-ferry-mvn/src/main/java/com/wechat/ferry/service/SDK.java vendored
View File

@ -4,10 +4,12 @@ import com.sun.jna.Library;
/**
* SDK.dll的接口类
*
* @Description
*
* @Author xinggq
* @Date 2024/7/10
*
* @author xinggq
* @date 2024-07-10 15:21
*/
public interface SDK extends Library {

4
clients/java/wechat-ferry-mvn/src/main/java/com/wechat/ferry/service/impl/TestServiceImpl.java vendored
View File

@ -4,9 +4,9 @@ import java.util.List;
import javax.annotation.Resource;
import com.wechat.ferry.handle.WeChatSocketClient;
import org.springframework.stereotype.Service;
import com.wechat.ferry.handle.WechatSocketClient;
import com.wechat.ferry.service.TestService;
import lombok.extern.slf4j.Slf4j;
@ -22,7 +22,7 @@ import lombok.extern.slf4j.Slf4j;
public class TestServiceImpl implements TestService {
@Resource
private WechatSocketClient wechatSocketClient;
private WeChatSocketClient wechatSocketClient;
@Override
public Boolean isLogin() {