小白版的springboot中集成mqtt服务(超级无敌详细),实现不了掐我头!!!

Posted 穆雄雄

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了小白版的springboot中集成mqtt服务(超级无敌详细),实现不了掐我头!!!相关的知识,希望对你有一定的参考价值。

大家好,我是雄雄,欢迎关注微信公众号雄雄的小课堂

现在是:2023年3月5日19:03:49

前言

在上一篇文章中,我介绍了如何在服务器中安装emqx消息服务器,这是在操作mqtt协议的时候必不可少的步骤,今天我们就来看看如何将mqtt服务集成到springboot项目中。

刚开始在集成的时候,也在网上看了些资料,也遇到了些坑,最后参考的是这篇文章,然后加上自己的简单修改,以及博主的悉心指导,最后终于实现了我预期的效果。
参考文章连接:点击这里

注意,在实现mqtt的时候,一定要先启动emqx消息服务器的服务,关于emqx的安装与使用,可以移步到这里

点击这里
下面我们来看看实现代码。


springboot项目中集成mqtt服务

为了模拟的更加真实点儿,我这边做了两个端,分别是客户端服务端,代码基本都一样,客户端就是将服务端复制过来改了下关键部分。

服务端

一、在pom文件中引入所需依赖。

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 引入fastjson -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>2.0.20</version>
        </dependency>
        <!--工具类-->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.8.3</version>
        </dependency>
        <!--mqtt相关配置-->
        <dependency>
            <groupId>org.springframework.integration</groupId>
            <artifactId>spring-integration-core</artifactId>
            <version>5.5.9</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.integration</groupId>
            <artifactId>spring-integration-mqtt</artifactId>
            <version>6.0.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.integration</groupId>
            <artifactId>spring-integration-stream</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-integration</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>5.3.20</version>
        </dependency>
        <!-- 集成redis依赖  -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

除了springboot 的依赖,其他的都有注释,如果mqtt的依赖引入报错的话,在重新引入一下就行.

二、在application.yml文件中加入mqtt的配置。

## MQTT配置
mqtt:
  host: tcp://127.0.0.1:1883
  userName: admin1
  passWord: 1234567
  qos: 1
  clientId: serve
  timeout: 10
  keepalive: 20

三、我这边为了后期编码方便,将一些公共部分都封装成了工具类,分别有redis的,ResponseResult的以及ResultCode

1.redis工具类:

package com.hookapi.common;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;

import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;

/**
 * @author: muxiongxiong
 * @date: 2023年02月22日 下午 5:48
 * 公众号:雄雄的小课堂
 * 博客:https://blog.csdn.net/qq_34137397
 * 个人站:http://www.穆雄雄.com
 * 个人站:http://www.muxiongxiong.cn
 * @Description: redis工具类
 */
@Component
public class RedisUtil 

    @Autowired
    private RedisTemplate redisTemplate;
    /**
     * 给一个指定的 key 值附加过期时间
     *
     * @param key
     * @param time
     * @return
     */
    public boolean expire(String key, long time) 
        return redisTemplate.expire(key, time, TimeUnit.SECONDS);
    
    /**
     * 根据key 获取过期时间
     *
     * @param key
     * @return
     */
    public long getTime(String key) 
        return redisTemplate.getExpire(key, TimeUnit.SECONDS);
    
    /**
     * 根据key 获取过期时间
     *
     * @param key
     * @return
     */
    public boolean hasKey(String key) 
        return redisTemplate.hasKey(key);
    
    /**
     * 移除指定key 的过期时间
     *
     * @param key
     * @return
     */
    public boolean persist(String key) 
        return redisTemplate.boundValueOps(key).persist();
    

    //- - - - - - - - - - - - - - - - - - - - -  String类型 - - - - - - - - - - - - - - - - - - - -

    /**
     * 根据key获取值
     *
     * @param key 键
     * @return 值
     */
    public Object get(String key) 
        return key == null ? null : redisTemplate.opsForValue().get(key);
    

    /**
     * 将值放入缓存
     *
     * @param key   键
     * @param value 值
     * @return true成功 false 失败
     */
    public void set(String key, String value) 
        redisTemplate.opsForValue().set(key, value);
    

    /**
     * 将值放入缓存并设置时间
     *
     * @param key   键
     * @param value 值
     * @param time  时间(秒) -1为无期限
     * @return true成功 false 失败
     */
    public void set(String key, String value, long time) 
        if (time > 0) 
            redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
         else 
            redisTemplate.opsForValue().set(key, value);
        
    

    /**
     * 批量添加 key (重复的键会覆盖)
     *
     * @param keyAndValue
     */
    public void batchSet(Map<String, String> keyAndValue) 
        redisTemplate.opsForValue().multiSet(keyAndValue);
    

    /**
     * 批量添加 key-value 只有在键不存在时,才添加
     * map 中只要有一个key存在,则全部不添加
     *
     * @param keyAndValue
     */
    public void batchSetIfAbsent(Map<String, String> keyAndValue) 
        redisTemplate.opsForValue().multiSetIfAbsent(keyAndValue);
    

    /**
     * 对一个 key-value 的值进行加减操作,
     * 如果该 key 不存在 将创建一个key 并赋值该 number
     * 如果 key 存在,但 value 不是长整型 ,将报错
     *
     * @param key
     * @param number
     */
    public Long increment(String key, long number) 
        return redisTemplate.opsForValue().increment(key, number);
    

    /**
     * 对一个 key-value 的值进行加减操作,
     * 如果该 key 不存在 将创建一个key 并赋值该 number
     * 如果 key 存在,但 value 不是 纯数字 ,将报错
     *
     * @param key
     * @param number
     */
    public Double increment(String key, double number) 
        return redisTemplate.opsForValue().increment(key, number);
    

    //- - - - - - - - - - - - - - - - - - - - -  set类型 - - - - - - - - - - - - - - - - - - - -

    /**
     * 将数据放入set缓存
     *
     * @param key 键
     * @return
     */
    public void sSet(String key, String value) 
        redisTemplate.opsForSet().add(key, value);
    

    /**
     * 获取变量中的值
     *
     * @param key 键
     * @return
     */
    public Set<Object> members(String key) 
        return redisTemplate.opsForSet().members(key);
    

    /**
     * 随机获取变量中指定个数的元素
     *
     * @param key   键
     * @param count 值
     * @return
     */
    public void randomMembers(String key, long count) 
        redisTemplate.opsForSet().randomMembers(key, count);
    

    /**
     * 随机获取变量中的元素
     *
     * @param key 键
     * @return
     */
    public Object randomMember(String key) 
        return redisTemplate.opsForSet().randomMember(key);
    

    /**
     * 弹出变量中的元素
     *
     * @param key 键
     * @return
     */
    public Object pop(String key) 
        return redisTemplate.opsForSet().pop("setValue");
    

    /**
     * 获取变量中值的长度
     *
     * @param key 键
     * @return
     */
    public long size(String key) 
        return redisTemplate.opsForSet().size(key);
    

    /**
     * 根据value从一个set中查询,是否存在
     *
     * @param key   键
     * @param value 值
     * @return true 存在 false不存在
     */
    public boolean sHasKey(String key, Object value) 
        return redisTemplate.opsForSet().isMember(key, value);
    

    /**
     * 检查给定的元素是否在变量中。
     *
     * @param key 键
     * @param obj 元素对象
     * @return
     */
    public boolean isMember(String key, Object obj) 
        return redisTemplate.opsForSet().isMember(key, obj);
    

    /**
     * 转移变量的元素值到目的变量。
     *
     * @param key     键
     * @param value   元素对象
     * @param destKey 元素对象
     * @return
     */
    public boolean move(String key, String value, String destKey) 
        return redisTemplate.opsForSet().move(key, value, destKey);
    

    /**
     * 批量移除set缓存中元素
     *
     * @param key    键
     * @param values 值
     * @return
     */
    public void remove(String key, Object... values) 
        redisTemplate.opsForSet().remove(key, values);
    

    /**
     * 通过给定的key求2个set变量的差值
     *
     * @param key     键
     * @param destKey 键
     * @return
     */
    public Set<Set> difference(String key, String destKey) 
        return redisTemplate.opsForSet().difference(key, destKey);
    


    //- - - - - - - - - - - - - - - - - - - - -  hash类型 - - - - - - - - - - - - - - - - - - - -

    /**
     * 加入缓存
     *
     * @param key 键
     * @param map 键
     * @return
     */
    public void add(String key, Map<String, String> map) 
        redisTemplate.opsForHash().putAll(key, map);
    

    /**
     * 获取 key 下的 所有  hashkey 和 value
     *
     * @param key 键
     * @return
     */
    public Map<Object, Object> getHashEntries(String key) 
        return redisTemplate.opsForHash().entries(key);
    

    /**
     * 验证指定 key 下 有没有指定的 hashkey
     *
     * @param key
     * @param hashKey
     * @return
     */
    public boolean hashKey(String key, String hashKey) 
        return redisTemplate.opsForHash().hasKey(key, hashKey);
    

    /**
     * 获取指定key的值string
     *
     * @param key  键
     * @param key2 键
     * @return
     */
    public String getMapString(String key, String key2) 
        return redisTemplate.opsForHash().get("map1", "key1").toString();
    

    /**
     * 获取指定的值Int
     *
     * @param key  键
     * @param key2 键
     * @return
     */
    public Integer getMapInt(String key, String key2) 
        return (Integer) redisTemplate.opsForHash().get("map1", "key1");
    

    /**
     * 弹出元素并删除
     *
     * @param key 键
     * @return
     */
    public String popValue(String key) 
        return redisTemplate.opsForSet().pop(key).toString();
    

    /**
     * 删除指定 hash 的 HashKey
     *
     * @param key
     * @param hashKeys
     * @return 删除成功的 数量
     */
    public Long delete(String key, String... hashKeys) 
        return redisTemplate.opsForHash().delete(key, hashKeys);
    

    /**
     * 给指定 hash 的 hashkey 做增减操作
     *
     * @param key
     * @param hashKey
     * @param number
     * @return
     */
    public Long increment(String key, String hashKey, long number) 
        return redisTemplate.opsForHash().increment(key, hashKey, number);
    

    /**
     * 给指定 hash 的 hashkey 做增减操作
     *
     * @param key
     * @param hashKey
     * @param number
     * @return
     */
    public Double increment(String key, String hashKey, Double number) 
        return redisTemplate.opsForHash().increment(key, hashKey, number);
    

    /**
     * 获取 key 下的 所有 hashkey 字段
     *
     * @param key
     * @return
     */
    public Set<Object> hashKeys(String key) 
        return redisTemplate.opsForHash().keys(key);
    

    /**
     * 获取指定 hash 下面的 键值对 数量
     *
     * @param key
     * @return
     */
    public Long hashSize(String key) 
        return redisTemplate.opsForHash().size(key);
    

    //- - - - - - - - - - - - - - - - - - - - -  list类型 - - - - - - - - - - - - - - - - - - - -

    /**
     * 在变量左边添加元素值
     *
     * @param key
     * @param value
     * @return
     */
    public void leftPush(String key, Object value) 
        redisTemplate.opsForList().leftPush(key, value);
    

    /**
     * 获取集合指定位置的值。
     *
     * @param key
     * @param index
     * @return
     */
    public Object index(String key, long index) 
        return redisTemplate.opsForList().index("list", 1);
    

    /**
     * 获取指定区间的值。
     *
     * @param key
     * @param start
     * @param end
     * @return
     */
    public List<Object> range(String key, long start, long end) 
        return redisTemplate.opsForList().range(key, start, end);
    

    /**
     * 把最后一个参数值放到指定集合的第一个出现中间参数的前面,
     * 如果中间参数值存在的话。
     *
     * @param key
     * @param pivot
     * @param value
     * @return
     */
    public void leftPush(String key, String pivot, String value) 
        redisTemplate.opsForList().leftPush(key, pivot, value)以上是关于小白版的springboot中集成mqtt服务(超级无敌详细),实现不了掐我头!!!的主要内容,如果未能解决你的问题,请参考以下文章

Springboot中集成swagger

在SpringBoot中集成单元测试

在SpringBoot中集成单元测试

SpringBoot中集成参数校验

SpringBoot中集成参数校验

springboot中集成memcached