Merge pull request #228 from PathfinderAx/master

feat(0): [java]-[wcferry-mvn]-集成插件及模块规范化
This commit is contained in:
Changhua 2024-09-23 11:55:00 +08:00 committed by GitHub
commit f2e467663b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
15 changed files with 2853 additions and 2449 deletions

View File

@ -47,7 +47,7 @@ wcferry:
### 编译运行 ### 编译运行
找到 src/main/java/com/iamteer/Main.java 类 找到 src/main/java/com/iamteer/WcferryApplication.java 类
直接启动即可 直接启动即可
@ -55,8 +55,6 @@ wcferry:
启动后springboot自身的端口为 9201 socket的端口为 10086 启动后springboot自身的端口为 9201 socket的端口为 10086
## 参与开发 ## 参与开发
### 核心依赖 ### 核心依赖
@ -68,5 +66,74 @@ wcferry:
| jna | 5.6.0 | 态访问系统本地库 | | jna | 5.6.0 | 态访问系统本地库 |
| nng-java | 1.4.0 | 本地包 | | nng-java | 1.4.0 | 本地包 |
### 模块结构
```
wcferry-mvn
├─dll 核心dll
│ ├─sdk.dll sdk文件
│ └─readme.txt 本目录说明文件
├─src 源
│ ├─main 重启命令
│ │ ├─java(com.iamteer) java代码目录
│ │ │ ├─config 配置
│ │ │ ├─entity 实体
│ │ │ ├─runner 运行(程序启动中与启动后的自动化任务都放置于此)
│ │ │ ├─service 业务接口
│ │ │ │ └─impl 业务实现类
│ │ │ ├─Client.java socket客户端
│ │ │ └─WcferryApplication.java 启动类
│ │ │resources 数据库脚本
│ │ │ ├─libs 本程序内置依赖包
│ │ │ ├─proto proto文件
│ │ │ ├─win32-x86-64 依赖程序
│ │ │ ├─application.yml 本程序主配置文件
│ │ │ └─logback-spring.xml 日志配置文件
├─pom.xml POM文件
├─README.MD 说明文件
```
### 配置说明
本程序主配置文件为 application.yml
#### 配置参数
本程序内置参数统一前缀wcferry 所有自定义本服务的参数请都放置在此前缀下,如:
```ymal
wcferry:
# DLL文件位置
dll-path: /dll/sdk.dll
```
#### 生成proto文件
本程序已经集成了生成proto文件的maven插件直接install即可生成proto文件且会在打包程序中去除 src/main/resources/proto
下面的内容,只保留实体类中的文件
默认install会重新根据 生成实体,如果不想被替换,请删除 src/main/resources/proto 下对应的文件即可
### 提交规范
本模块希望大家使用统一提交格式,便于区分
格式:类型(任务号/缺陷号/没有使用0替代): [模块名称]-[子模块名称]-本次修改的说明
如:
```cmd
feat(0): [java]-[wcferry-mvn]-基础类目录划分迁移及代码格式
```
| 名称 | 版本 |
|------|--------------|
| feat | 新功能 |
| fix | 缺陷 |
| ... | 其他等git规范中的均可 |

3
clients/java/wcferry-mvn/dll/.gitkeep vendored Normal file
View File

@ -0,0 +1,3 @@
# Ignore everything in this directory
*
# Except this file !.gitkeep

View File

@ -0,0 +1,6 @@
说明:
由于项目规范限制本目录保留但最新的DLL还需要各位自行去下载解压
请把最新的 https://github.com/lich0821/WeChatFerry/releases/latest 下载的文件解压后放到该目录下
sdk.dll
spy.dll
spy_debug.dll

View File

@ -61,4 +61,54 @@
</dependency> </dependency>
</dependencies> </dependencies>
<build>
<extensions>
<extension>
<groupId>kr.motd.maven</groupId>
<artifactId>os-maven-plugin</artifactId>
<version>1.5.0.Final</version>
</extension>
</extensions>
<!-- 同时添加maven插件用于编译protobuf生成java文件 -->
<plugins>
<plugin>
<groupId>org.xolstice.maven.plugins</groupId>
<artifactId>protobuf-maven-plugin</artifactId>
<version>0.5.0</version>
<configuration>
<!-- 注意,需要与 com.google.protobuf:protobuf-java 一致 -->
<protocArtifact>
com.google.protobuf:protoc:3.22.2:exe:${os.detected.classifier}
</protocArtifact>
<!-- 默认值proto源文件路径 -->
<protoSourceRoot>${project.basedir}/src/main/resources/proto</protoSourceRoot>
<!-- 默认值proto目标java文件路径如果不指定则只在jar与编译中生成 -->
<outputDirectory>src/main/java</outputDirectory>
<pluginId>grpc-java</pluginId>
<!-- 设置是否在生成java文件之前清空outputDirectory的文件默认值为true设置为false时也会覆盖同名文件 -->
<clearOutputDirectory>false</clearOutputDirectory>
</configuration>
<executions>
<execution>
<goals>
<goal>compile</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.3.0</version>
<configuration>
<excludes>
<exclude>**/*.proto</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
</project> </project>

View File

@ -8,11 +8,24 @@ import java.util.Map;
import java.util.concurrent.ArrayBlockingQueue; import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.BlockingQueue; import java.util.concurrent.BlockingQueue;
import com.sun.jna.Native; import com.iamteer.service.SDK;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
import com.iamteer.Wcf.*; import com.iamteer.entity.Wcf;
import com.iamteer.entity.Wcf.DbQuery;
import com.iamteer.entity.Wcf.DbRow;
import com.iamteer.entity.Wcf.DbTable;
import com.iamteer.entity.Wcf.DecPath;
import com.iamteer.entity.Wcf.Functions;
import com.iamteer.entity.Wcf.MemberMgmt;
import com.iamteer.entity.Wcf.Request;
import com.iamteer.entity.Wcf.Response;
import com.iamteer.entity.Wcf.RpcContact;
import com.iamteer.entity.Wcf.UserInfo;
import com.iamteer.entity.Wcf.Verification;
import com.iamteer.entity.Wcf.WxMsg;
import com.sun.jna.Native;
import io.sisu.nng.Socket; import io.sisu.nng.Socket;
import io.sisu.nng.pair.Pair1Socket; import io.sisu.nng.pair.Pair1Socket;
@ -60,7 +73,6 @@ public class Client {
} }
} }
public void connectRPC(String url, SDK INSTANCE) { public void connectRPC(String url, SDK INSTANCE) {
try { try {
cmdSocket = new Pair1Socket(); cmdSocket = new Pair1Socket();
@ -168,8 +180,7 @@ public class Client {
*/ */
public List<DbRow> querySql(String db, String sql) { public List<DbRow> querySql(String db, String sql) {
DbQuery dbQuery = DbQuery.newBuilder().setSql(sql).setDb(db).build(); DbQuery dbQuery = DbQuery.newBuilder().setSql(sql).setDb(db).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_EXEC_DB_QUERY_VALUE) Request req = Request.newBuilder().setFuncValue(Functions.FUNC_EXEC_DB_QUERY_VALUE).setQuery(dbQuery).build();
.setQuery(dbQuery).build();
Response rsp = sendCmd(req); Response rsp = sendCmd(req);
if (rsp != null) { if (rsp != null) {
return rsp.getRows().getRowsList(); return rsp.getRows().getRowsList();
@ -199,8 +210,7 @@ public class Client {
* @return * @return
*/ */
public Map<String, String> getDbTables(String db) { public Map<String, String> getDbTables(String db) {
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_GET_DB_TABLES_VALUE).setStr(db) Request req = Request.newBuilder().setFuncValue(Functions.FUNC_GET_DB_TABLES_VALUE).setStr(db).build();
.build();
Response rsp = sendCmd(req); Response rsp = sendCmd(req);
Map<String, String> tables = new HashMap<>(); Map<String, String> tables = new HashMap<>();
if (rsp != null) { if (rsp != null) {
@ -225,10 +235,8 @@ public class Client {
* "wxid_xxxxxxxxxxxxx1,wxid_xxxxxxxxxxxxx2"); * "wxid_xxxxxxxxxxxxx1,wxid_xxxxxxxxxxxxx2");
**/ **/
public int sendText(String msg, String receiver, String aters) { public int sendText(String msg, String receiver, String aters) {
Wcf.TextMsg textMsg = Wcf.TextMsg.newBuilder().setMsg(msg).setReceiver(receiver).setAters(aters) Wcf.TextMsg textMsg = Wcf.TextMsg.newBuilder().setMsg(msg).setReceiver(receiver).setAters(aters).build();
.build(); Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_TXT_VALUE).setTxt(textMsg).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_TXT_VALUE).setTxt(textMsg)
.build();
logger.debug("sendText: {}", bytesToHex(req.toByteArray())); logger.debug("sendText: {}", bytesToHex(req.toByteArray()));
Response rsp = sendCmd(req); Response rsp = sendCmd(req);
int ret = -1; int ret = -1;
@ -248,8 +256,7 @@ public class Client {
*/ */
public int sendImage(String path, String receiver) { public int sendImage(String path, String receiver) {
Wcf.PathMsg pathMsg = Wcf.PathMsg.newBuilder().setPath(path).setReceiver(receiver).build(); Wcf.PathMsg pathMsg = Wcf.PathMsg.newBuilder().setPath(path).setReceiver(receiver).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_IMG_VALUE).setFile(pathMsg) Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_IMG_VALUE).setFile(pathMsg).build();
.build();
logger.debug("sendImage: {}", bytesToHex(req.toByteArray())); logger.debug("sendImage: {}", bytesToHex(req.toByteArray()));
Response rsp = sendCmd(req); Response rsp = sendCmd(req);
int ret = -1; int ret = -1;
@ -269,8 +276,7 @@ public class Client {
*/ */
public int sendFile(String path, String receiver) { public int sendFile(String path, String receiver) {
Wcf.PathMsg pathMsg = Wcf.PathMsg.newBuilder().setPath(path).setReceiver(receiver).build(); Wcf.PathMsg pathMsg = Wcf.PathMsg.newBuilder().setPath(path).setReceiver(receiver).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_FILE_VALUE).setFile(pathMsg) Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_FILE_VALUE).setFile(pathMsg).build();
.build();
logger.debug("sendFile: {}", bytesToHex(req.toByteArray())); logger.debug("sendFile: {}", bytesToHex(req.toByteArray()));
Response rsp = sendCmd(req); Response rsp = sendCmd(req);
int ret = -1; int ret = -1;
@ -291,10 +297,8 @@ public class Client {
* @return 发送结果状态码 * @return 发送结果状态码
*/ */
public int sendXml(String receiver, String xml, String path, int type) { public int sendXml(String receiver, String xml, String path, int type) {
Wcf.XmlMsg xmlMsg = Wcf.XmlMsg.newBuilder().setContent(xml).setReceiver(receiver).setPath(path) Wcf.XmlMsg xmlMsg = Wcf.XmlMsg.newBuilder().setContent(xml).setReceiver(receiver).setPath(path).setType(type).build();
.setType(type).build(); Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_XML_VALUE).setXml(xmlMsg).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_XML_VALUE).setXml(xmlMsg)
.build();
logger.debug("sendXml: {}", bytesToHex(req.toByteArray())); logger.debug("sendXml: {}", bytesToHex(req.toByteArray()));
Response rsp = sendCmd(req); Response rsp = sendCmd(req);
int ret = -1; int ret = -1;
@ -314,8 +318,7 @@ public class Client {
*/ */
public int sendEmotion(String path, String receiver) { public int sendEmotion(String path, String receiver) {
Wcf.PathMsg pathMsg = Wcf.PathMsg.newBuilder().setPath(path).setReceiver(receiver).build(); Wcf.PathMsg pathMsg = Wcf.PathMsg.newBuilder().setPath(path).setReceiver(receiver).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_EMOTION_VALUE) Request req = Request.newBuilder().setFuncValue(Functions.FUNC_SEND_EMOTION_VALUE).setFile(pathMsg).build();
.setFile(pathMsg).build();
logger.debug("sendEmotion: {}", bytesToHex(req.toByteArray())); logger.debug("sendEmotion: {}", bytesToHex(req.toByteArray()));
Response rsp = sendCmd(req); Response rsp = sendCmd(req);
int ret = -1; int ret = -1;
@ -336,8 +339,7 @@ public class Client {
public int acceptNewFriend(String v3, String v4) { public int acceptNewFriend(String v3, String v4) {
int ret = -1; int ret = -1;
Verification verification = Verification.newBuilder().setV3(v3).setV4(v4).build(); Verification verification = Verification.newBuilder().setV3(v3).setV4(v4).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_ACCEPT_FRIEND_VALUE) Request req = Request.newBuilder().setFuncValue(Functions.FUNC_ACCEPT_FRIEND_VALUE).setV(verification).build();
.setV(verification).build();
Response rsp = sendCmd(req); Response rsp = sendCmd(req);
if (rsp != null) { if (rsp != null) {
ret = rsp.getStatus(); ret = rsp.getStatus();
@ -355,8 +357,7 @@ public class Client {
public int addChatroomMembers(String roomID, String wxIds) { public int addChatroomMembers(String roomID, String wxIds) {
int ret = -1; int ret = -1;
MemberMgmt memberMgmt = MemberMgmt.newBuilder().setRoomid(roomID).setWxids(wxIds).build(); MemberMgmt memberMgmt = MemberMgmt.newBuilder().setRoomid(roomID).setWxids(wxIds).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_ADD_ROOM_MEMBERS_VALUE) Request req = Request.newBuilder().setFuncValue(Functions.FUNC_ADD_ROOM_MEMBERS_VALUE).setM(memberMgmt).build();
.setM(memberMgmt).build();
Response rsp = sendCmd(req); Response rsp = sendCmd(req);
if (rsp != null) { if (rsp != null) {
ret = rsp.getStatus(); ret = rsp.getStatus();
@ -374,8 +375,7 @@ public class Client {
public boolean decryptImage(String srcPath, String dstPath) { public boolean decryptImage(String srcPath, String dstPath) {
int ret = -1; int ret = -1;
DecPath build = DecPath.newBuilder().setSrc(srcPath).setDst(dstPath).build(); DecPath build = DecPath.newBuilder().setSrc(srcPath).setDst(dstPath).build();
Request req = Request.newBuilder().setFuncValue(Functions.FUNC_DECRYPT_IMAGE_VALUE) Request req = Request.newBuilder().setFuncValue(Functions.FUNC_DECRYPT_IMAGE_VALUE).setDec(build).build();
.setDec(build).build();
Response rsp = sendCmd(req); Response rsp = sendCmd(req);
if (rsp != null) { if (rsp != null) {
ret = rsp.getStatus(); ret = rsp.getStatus();
@ -509,8 +509,7 @@ public class Client {
gender = "未知"; gender = "未知";
} }
logger.info("{}, {}, {}, {}, {}, {}, {}", c.getWxid(), c.getName(), c.getCode(), logger.info("{}, {}, {}, {}, {}, {}, {}", c.getWxid(), c.getName(), c.getCode(), c.getCountry(), c.getProvince(), c.getCity(), gender);
c.getCountry(), c.getProvince(), c.getCity(), gender);
} }
} }
@ -532,5 +531,5 @@ public class Client {
waitMs(1000); waitMs(1000);
} }
} }
}
}

View File

@ -0,0 +1,35 @@
package com.iamteer.config;
import java.util.Collections;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter;
import org.springframework.web.client.RestTemplate;
/**
* 配置类-protobuf
*
* @author chandler
* @date 2024-09-26 21:35
*/
@Configuration
public class ProtobufConfig {
/**
* protobuf 序列化
*/
@Bean
ProtobufHttpMessageConverter protobufHttpMessageConverter() {
return new ProtobufHttpMessageConverter();
}
/**
* protobuf 反序列化
*/
@Bean
RestTemplate restTemplate(ProtobufHttpMessageConverter protobufHttpMessageConverter) {
return new RestTemplate(Collections.singletonList(protobufHttpMessageConverter));
}
}

View File

@ -6,10 +6,10 @@ import org.springframework.stereotype.Component;
import lombok.Data; import lombok.Data;
/** /**
* 配置文件-UAM模块的外部接口 * 配置文件-wcferry的配置文件
* *
* @author chandler * @author chandler
* @date 2024-04-26 21:35 * @date 2024-09-21 21:35
*/ */
@Data @Data
@Component @Component
@ -22,7 +22,7 @@ public class WcferryProperties {
private String dllPath; private String dllPath;
/** /**
* 端口 * socket端口
*/ */
private Integer socketPort; private Integer socketPort;

View File

@ -2,7 +2,6 @@ package com.iamteer.runner;
import javax.annotation.Resource; import javax.annotation.Resource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.ApplicationArguments; import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner; import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;

View File

@ -1,4 +1,4 @@
package com.iamteer; package com.iamteer.service;
import com.sun.jna.Library; import com.sun.jna.Library;

View File

@ -0,0 +1,3 @@
# Ignore everything in this directory
*
# Except this file !.gitkeep

View File

@ -0,0 +1,3 @@
# Ignore everything in this directory
*
# Except this file !.gitkeep

View File

@ -0,0 +1,236 @@
syntax = "proto3";
package wcf;
option java_package = "com.iamteer.entity";
enum Functions {
FUNC_RESERVED = 0x00;
FUNC_IS_LOGIN = 0x01;
FUNC_GET_SELF_WXID = 0x10;
FUNC_GET_MSG_TYPES = 0x11;
FUNC_GET_CONTACTS = 0x12;
FUNC_GET_DB_NAMES = 0x13;
FUNC_GET_DB_TABLES = 0x14;
FUNC_GET_USER_INFO = 0x15;
FUNC_GET_AUDIO_MSG = 0x16;
FUNC_SEND_TXT = 0x20;
FUNC_SEND_IMG = 0x21;
FUNC_SEND_FILE = 0x22;
FUNC_SEND_XML = 0x23;
FUNC_SEND_EMOTION = 0x24;
FUNC_SEND_RICH_TXT = 0x25;
FUNC_SEND_PAT_MSG = 0x26;
FUNC_FORWARD_MSG = 0x27;
FUNC_ENABLE_RECV_TXT = 0x30;
FUNC_DISABLE_RECV_TXT = 0x40;
FUNC_EXEC_DB_QUERY = 0x50;
FUNC_ACCEPT_FRIEND = 0x51;
FUNC_RECV_TRANSFER = 0x52;
FUNC_REFRESH_PYQ = 0x53;
FUNC_DOWNLOAD_ATTACH = 0x54;
FUNC_GET_CONTACT_INFO = 0x55;
FUNC_REVOKE_MSG = 0x56;
FUNC_REFRESH_QRCODE = 0x57;
FUNC_DECRYPT_IMAGE = 0x60;
FUNC_EXEC_OCR = 0x61;
FUNC_ADD_ROOM_MEMBERS = 0x70;
FUNC_DEL_ROOM_MEMBERS = 0x71;
FUNC_INV_ROOM_MEMBERS = 0x72;
}
message Request
{
Functions func = 1;
oneof msg
{
Empty empty = 2; //
string str = 3; //
TextMsg txt = 4; //
PathMsg file = 5; //
DbQuery query = 6; //
Verification v = 7; //
MemberMgmt m = 8; //
XmlMsg xml = 9; // XML参数结构
DecPath dec = 10; //
Transfer tf = 11; //
uint64 ui64 = 12 [ jstype = JS_STRING ]; // 64
bool flag = 13; //
AttachMsg att = 14; //
AudioMsg am = 15; //
RichText rt = 16; //
PatMsg pm = 17; //
ForwardMsg fm = 18; //
}
}
message Response
{
Functions func = 1;
oneof msg
{
int32 status = 2; // Int
string str = 3; //
WxMsg wxmsg = 4; //
MsgTypes types = 5; //
RpcContacts contacts = 6; //
DbNames dbs = 7; //
DbTables tables = 8; //
DbRows rows = 9; //
UserInfo ui = 10; //
OcrMsg ocr = 11; // OCR
};
}
message Empty { }
message WxMsg
{
bool is_self = 1; //
bool is_group = 2; //
uint64 id = 3 [ jstype = JS_STRING ]; // id
uint32 type = 4; //
uint32 ts = 5; //
string roomid = 6; // id
string content = 7; //
string sender = 8; //
string sign = 9; // Sign
string thumb = 10; //
string extra = 11; //
string xml = 12; // xml
}
message TextMsg
{
string msg = 1; //
string receiver = 2; // @
string aters = 3; // @
}
message PathMsg
{
string path = 1; //
string receiver = 2; //
}
message XmlMsg
{
string receiver = 1; //
string content = 2; // xml
string path = 3; //
int32 type = 4; //
}
message MsgTypes { map<int32, string> types = 1; }
message RpcContact
{
string wxid = 1; // id
string code = 2; //
string remark = 3; //
string name = 4; //
string country = 5; //
string province = 6; // /
string city = 7; //
int32 gender = 8; //
}
message RpcContacts { repeated RpcContact contacts = 1; }
message DbNames { repeated string names = 1; }
message DbTable
{
string name = 1; //
string sql = 2; // SQL
}
message DbTables { repeated DbTable tables = 1; }
message DbQuery
{
string db = 1; //
string sql = 2; // SQL
}
message DbField
{
int32 type = 1; //
string column = 2; //
bytes content = 3; //
}
message DbRow { repeated DbField fields = 1; }
message DbRows { repeated DbRow rows = 1; }
message Verification
{
string v3 = 1; //
string v4 = 2; // Ticket
int32 scene = 3; // 17 30
}
message MemberMgmt
{
string roomid = 1; // ID
string wxids = 2; //
}
message UserInfo
{
string wxid = 1; // ID
string name = 2; //
string mobile = 3; //
string home = 4; // /
}
message DecPath
{
string src = 1; //
string dst = 2; //
}
message Transfer
{
string wxid = 1; //
string tfid = 2; // id transferid
string taid = 3; // Transaction id
}
message AttachMsg
{
uint64 id = 1 [ jstype = JS_STRING ]; // id
string thumb = 2; // thumb
string extra = 3; // extra
}
message AudioMsg
{
uint64 id = 1 [ jstype = JS_STRING ]; // id
string dir = 2; //
}
message RichText
{
string name = 1; //
string account = 2; // id
string title = 3; //
string digest = 4; //
string url = 5; //
string thumburl = 6; //
string receiver = 7; //
}
message PatMsg
{
string roomid = 1; // id
string wxid = 2; // wxid
}
message OcrMsg
{
int32 status = 1; //
string result = 2; //
}
message ForwardMsg
{
uint64 id = 1 [ jstype = JS_STRING ]; // ID
string receiver = 2; // roomId wxid
}

View File

@ -0,0 +1,3 @@
# Ignore everything in this directory
*
# Except this file !.gitkeep

Binary file not shown.