# han-tools

**Repository Path**: laich/han-tools

## Basic Information

- **Project Name**: han-tools
- **Description**: 开发工具类 mqtt服务 等
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: release_1.2.0
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-18
- **Last Updated**: 2024-05-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# han-tools
han-tools工具类，分2个项目

han tools
## Using it to facilitate the development of mybatis+spring database
* 整合了spring和mybatis-plus的CURL 工具集成类

#### 项目介绍
轻量级物联网MQTT服务器, 快速部署, 支持集群.

#### 软件架构说明
基于netty+springboot+redis技术栈实现
1. 使用netty实现通信及协议解析
2. 使用springboot提供依赖注入及属性配置
3. 使用memory 或者 redis 实现存储, 分布式锁, 集群和集群间通信
4. 支持集群，支持ssl 单向和双向认证。


#### 项目结构
```
iot-mqtt-server
  ├── mqtt-example -- MQTT服务连接案例
  ├── mqtt-broker -- MQTT broker 服务器
  ├── mqtt-common -- 公共类及其他模块使用的服务接口及对象
  ├── mqtt-server --  MQTT服务器功能的核心实现
  ├── han-mqtt-service-spring-stater spring 集成stater
```

#### 功能说明
1. 参考MQTT3.1.1规范实现
2. 完整的QoS服务质量等级实现
3. 遗嘱消息, 保留消息及消息分发重试
4. 心跳机制
5. 连接认证(强制开启)
6. 支持 第三语言 http 对接.
7. SSL方式连接(支持非SSL连接)
8. 主题过滤(未完全实现标准: 以#或+符号开头的、以/符号结尾的及不存在/符号的订阅按非法订阅处理, 这里没有参考标准协议)
9. websocket支持
10.  集群功能

#### 快速开始
参考 example
```
    <dependency>
			<groupId>com.todostudy</groupId>
			<artifactId>han-mqtt-service-spring-stater</artifactId>
			<version>版本号 version</version>
		</dependency>
```
* 认证代码
```
@Service
public class AuthService implements IAuthService {

	public boolean verifyAuth(String username, String password,String clientId) {
		//实现业务
			return true;

	}
```
* 上线下线通知
```
@Slf4j
@Service
public class MqttListenConnectServer implements IMqttListenConnect {

    @Autowired
    private IMqttServerTemplate mqttServerTemplate;

    @Override
    public void online(String clientId, String username) {
        log.info("--online--{}", clientId);
    }

    @Override
    public void offline(String clientId, String username, String reason) {
        log.info("------offline--{}", clientId);
    }
}
```
* 消息监听
```
@Slf4j
@Service
public class ListenMessageServer implements IMqttListenMessage {

    @Autowired
    private IMqttServerTemplate mqttServerTemplate;

    @Override
    public void onMessage(String clientId, String topic, MqttQoS qos, byte[] message){
        //业务处理...
        log.info("--onMessage---clientId:{},msg:{}",clientId, new String(message));
    }
}
```

#### 集群使用
1. 开启redis 。主要存储 topic
2. 前端加代理 IP 负载即可以。


#### 自定义 - 连接认证
- 默认只是简单使用对用户名进行RSA密钥对加密生成密码, 连接认证时对密码进行解密和相应用户名进行匹配认证
- 使用中如果需要实现连接数据库或其他方式进行连接认证, 只需要重写`mqtt-auth`模块下的相应方法即可

#### 关于双向认证
* 客户端需要3个证书。 对应 文件夹 ssl-server 和 ssl-client
* 生成方式，参考 https://www.alibabacloud.com/help/zh/iot/use-cases/connect-an-mqtt-gateway-device-to-iot-platform-by-using-mqtt-fx#9f1d9fa0767zf
* 阿里的文档有很细的说明。
*


#### 自定义 - 服务端证书
- 服务端证书存储在`mqtt-broker`的`resources/keystore/`
- 用户可以制作自己的证书, 但存储位置和文件名必须使用上述描述的位置及文件名

#### 生成环境部署