devbox
黑客灵魂
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Springboot集成redis和mybatis-plus及websocket异常框架代码封装_springboot websocket redis

作者：黑客灵魂 | 2024-07-13 05:49:56

赞

踩

springboot websocket redis

在软件开发过程中，一款封装完善简洁大气的全家桶框架，能大大提升开发人员的工作效率，同时还能降低代码的复杂程序，也便于后期方便维护。本文所涉及源代码在文章最后，有下载链接。

本文章所涉及封装的框架，可直接用于项目开发。

在集成软件开发框架时，我们需要考虑哪些要素：

1、用哪些技术

2、异常信息的处理

3、日志的打印，最好是能带参数打印sql日志（非问号形式的带参sql），本框架就是带参数打印sql，方便调试

4、接口返回数据格式的封装（瞧不起一些垃圾封装）

本博文主要分五大块讲解，分别为websocket的使用、mybatis-plus的使用、redis的使用、异常信息怎么使用、日志打印（重点是带参数打印sql语句，方便开发调式）

一、Websockt的集成
1、初始化配置
  1. @Configuration
  2. public class WebSocketConfig  {
  3.     /**
  4.      * 会自动注册使用了@ServerEndpoint注解声明的Websocket endpoint
  5.      * 要注意，如果使用独立的servlet容器，
  6.      * 而不是直接使用springboot的内置容器，
  7.      * 就不要注入ServerEndpointExporter，因为它将由容器自己提供和管理。
  8.      */
  9.     @Bean
  10.     public ServerEndpointExporter serverEndpointExporter() {
  11.         return new ServerEndpointExporter();
  12.     }
  13. }
2、服务端收消息
  1. @Slf4j
  2. @Component
  3. @ServerEndpoint(value = "/websocket")
  4. public class WebsocketGet {
  5.  
  6.     /**
  7.      * 连接事件，加入注解
  8.      * @param session
  9.      */
  10.     @OnOpen
  11.     public void onOpen(Session session) {
  12.         String orderId = WebsocketSend.getParam(WebsocketSend.sessionKey, session);
  13.         log.info("Websocket连接已打开，当前orderId为："+orderId);
  14.         // 添加到session的映射关系中
  15.         WebsocketSend.addSession(orderId, session);
  16.         //测试发送消息
  17.         WebsocketSend.sendMessage(orderId, WsResultVo.success("恭喜，已建立连接"));
  18.     }
  19.     /**
  20.      * 一、websocker (2)接收到客户端用户上传的消息
  21.      * @param session
  22.      */
  23.     @OnMessage
  24.     public void onMessage(Session session, String message) {
  25.         log.info("收到Websocket消息："+message);
  26.     }
  27.     /**
  28.      * 连接事件，加入注解
  29.      * 用户断开链接
  30.      *
  31.      * @param session
  32.      */
  33.     @OnClose
  34.     public void onClose(Session session) {
  35.         String orderId = WebsocketSend.getParam(WebsocketSend.sessionKey, session);
  36.         // 删除映射关系
  37.         WebsocketSend.removeSession(orderId);
  38.     }
  39.  
  40.     /**
  41.      * 处理用户活连接异常
  42.      *
  43.      * @param session
  44.      * @param throwable
  45.      */
  46.     @OnError
  47.     public void onError(Session session, Throwable throwable) {
  48.         try {
  49.             if (session.isOpen()) {
  50.                 session.close();
  51.             }
  52.         } catch (IOException e) {
  53.             e.printStackTrace();
  54.         }
  55.         throwable.printStackTrace();
  56.     }
  57. }
3、向客户端发送消息
  1. /**
  2.  * Websocket工具类
  3.  * 记录当前在线的链接对链接进行操作
  4.  */
  5. public class WebsocketSend {
  6.     /**
  7.      * 日志信息
  8.      */
  9.     private static final Logger LOGGER = LoggerFactory.getLogger(WebsocketSend.class);
  10.     /**
  11.      * 记录当前在线的Session
  12.      */
  13.     private static final Map<String, Session> ONLINE_SESSION = new ConcurrentHashMap<>();
  14.     public static final String sessionKey = "orderId";
  15.  
  16.     /**
  17.      * 添加session
  18.      *
  19.      * @param userId
  20.      * @param session
  21.      */
  22.     public static void addSession(String userId, Session session) {
  23.         // 此处只允许一个用户的session链接。一个用户的多个连接，我们视为无效。
  24.         ONLINE_SESSION.putIfAbsent(userId, session);
  25.     }
  26.  
  27.     /**
  28.      * 关闭session
  29.      *
  30.      * @param userId
  31.      */
  32.     public static void removeSession(String userId) {
  33.         ONLINE_SESSION.remove(userId);
  34.     }
  35.  
  36.     /**
  37.      * 给单个用户推送消息
  38.      *
  39.      * @param session
  40.      * @param message
  41.      */
  42.     public static void sendMessage(Session session, String message) {
  43.         if (session == null) {
  44.             return;
  45.         }
  46.  
  47.         // 同步
  48.         RemoteEndpoint.Async async = session.getAsyncRemote();
  49.         async.sendText(message);
  50.     }
  51.  
  52.     /**
  53.      * 向所有在线人发送消息
  54.      *
  55.      * @param message
  56.      */
  57.     public static void sendMessageForAll(String message) {
  58.         //jdk8 新方法
  59.         ONLINE_SESSION.forEach((sessionId, session) -> {
  60.             if (session.isOpen()) {
  61.                 sendMessage(session, message);
  62.             }
  63.         });
  64.     }
  65.  
  66.     /**
  67.      * 根据用户ID发送消息
  68.      *
  69.      * @param result
  70.      */
  71.     public static void sendMessage(String sessionId, WsResultVo result) {
  72.         sendMessage(sessionId, JSON.toJSONString(result));
  73.     }
  74.  
  75.     /**
  76.      * 根据用户ID发送消息
  77.      *
  78.      * @param message
  79.      */
  80.     public static void sendMessage(String sessionId, String message) {
  81.         Session session = ONLINE_SESSION.get(sessionId);
  82.         //判断是否存在该用户的session，判断是否还在线
  83.         if (session == null || !session.isOpen()) {
  84.             return;
  85.         }
  86.         sendMessage(session, message);
  87.     }
  88.  
  89.     /**
  90.      * 根据ID获取Session
  91.      *
  92.      * @param sessionId
  93.      */
  94.     public static Session getSession(String sessionId) {
  95.         Session session = ONLINE_SESSION.get(sessionId);
  96.         return session;
  97.     }
  98.  
  99.     /**
  100.      * 根据传过来的key获取session中的参数
  101.      * @param key
  102.      * @param session
  103.      * @return
  104.      */
  105.     public static String getParam(String key, Session session) {
  106.         Map map = session.getRequestParameterMap();
  107.         Object userId1 = map.get(key);
  108.         if (userId1 == null) {
  109.             return null;
  110.         }
  111.  
  112.         String s = userId1.toString();
  113.         s = s.replaceAll("\\[", "").replaceAll("]", "");
  114.  
  115.         if (!StringUtils.isEmpty(s)) {
  116.             return s;
  117.         }
  118.         return null;
  119.     }
  120.  
  121. }
4，websocket测试（客户端我们用apifox软件，自行百度下载）

先启动服务端，运行ServerApplication.java，然后apifox，点击连接服务器，如下截图

点击【连接】请求地址：ws://127.0.0.1:8080/ck/websocket?orderId=123456，注意参数orderId必填

（1）客户端apifox向服务端发送消息

（2）服务器端向客户端发送消息，打开swagger地址：http://localhost:8080/ck/swagger-ui.html

通过swagger调用后端接口，后端收到接口请求，再向websocket客户端发送消息

二、Mybatis-plus的集成
1、初始化配置
  1. @Configuration
  2. @MapperScan("com.ck.server.web.mapper")
  3. public class MybatisPlusConfig {
  4.     /**
  5.      * 添加分页插件
  6.      */
  7.     @Bean
  8.     public MybatisPlusInterceptor mybatisPlusInterceptor() {
  9.         MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
  10.         interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));//如果配置多个插件,切记分页最后添加
  11.         //interceptor.addInnerInterceptor(new PaginationInnerInterceptor()); 如果有多数据源可以不配具体类型 否则都建议配上具体的DbType
  12.         return interceptor;
  13.     }
  14. }
2、接口的使用

 打开swagger地址：http://localhost:8080/ck/swagger-ui.html

3、mybatis-pluse的增、删、查、保存

controller部分

  1. @GetMapping("/mybatis-plus/getPage")
  2.     @ApiOperation("二、Mybatis-plus查询（1）分页查询")
  3.     public PageBeanVo<User> getPage(UserParam param) {
  4.         PageBeanVo pageBeanVo = userService.getPage(param);
  5.         return pageBeanVo;
  6.     }
  7.  
  8.     @PostMapping("/mybatis-plus/save")
  9.     @ApiOperation("二、Mybatis-plus查询（2）保存")
  10.     public ResultInfoVo save(String name,Integer age,String email) {
  11.         User user = new User();
  12.         user.setName(name);
  13.         user.setAge(age);
  14.         user.setEmail(email);
  15.         userService.save(user);
  16.         return new ResultInfoVo();
  17.     }
  18.  
  19.     @GetMapping("/mybatis-plus/getById")
  20.     @ApiOperation("二、Mybatis-plus查询（3）根据id查询")
  21.     public ResultInfoVo<User> getById(Integer id) {
  22.         User user = userService.getById(id);
  23.         return new ResultInfoVo(user);
  24.     }
  25.  
  26.     @DeleteMapping("/mybatis-plus/deleteById")
  27.     @ApiOperation("二、Mybatis-plus查询（4）根据id删除")
  28.     public ResultInfoVo<User> deleteById(Integer id) {
  29.          userService.deleteById(id);
  30.         return new ResultInfoVo();
  31.     }

service部分

  1. @Service
  2. public class UserService {
  3.     @Autowired
  4.     private UserMapper userMapper;
  5.     /**
  6.      * 根据id查询
  7.      * @param id
  8.      * @return
  9.      */
  10.     public User getById(Integer id){
  11.         return userMapper.selectById(id);
  12.     }
  13.     /**
  14.      * 分页查询
  15.      * @param param
  16.      * @return
  17.      */
  18.     public PageBeanVo<User> getPage(UserParam param){
  19.         IPage<User> page = userMapper.getPage(param);
  20.         System.out.println(page);
  21.         return new PageBeanVo(page.getTotal(),page.getRecords());
  22.     }
  23.     /**
  24.      * 保付
  25.      * @param user
  26.      */
  27.     @Transactional
  28.     public void save(User user){
  29.         userMapper.insert(user);
  30.     }
  31.     /**
  32.      * 保付
  33.      * @param id
  34.      */
  35.     @Transactional
  36.     public void deleteById(Integer id){
  37.         userMapper.deleteById(id);
  38.     }
  39. }

mapper部分

  1. public interface UserMapper extends BaseMapper<User> {
  2.     /**
  3.      * 分页查询
  4.      * @param pageParam
  5.      * @return
  6.      */
  7.     IPage<User> getPage(IPage pageParam);
  8. }

mapper对应的xml的部分

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE mapper
  3.         PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  4.         "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  5. <mapper namespace="com.ck.server.web.mapper.UserMapper">
  6.     <select id="getPage" resultType="com.ck.server.web.model.User">
  7.         SELECT * FROM  user WHERE 1=1
  8.         <if test="id!= null and id!= ''">
  9.             and id =#{id}
  10.         </if>
  11.         <if test="name!= null and name!= ''">
  12.             and name like concat('%',#{name},'%')
  13.         </if>
  14.     </select>
  15. </mapper>

来个分页查询的截图：

三、redis集成
1、初始化配置
  1. @Configuration
  2. public class RedisConfig {
  3. 	@Bean
  4. 	public RedisTemplate<String, Serializable> redisTemplate(LettuceConnectionFactory connectionFactory) {
  5. 		RedisTemplate<String, Serializable> redisTemplate = new RedisTemplate<>();
  6. //		redisTemplate.setKeySerializer(new StringRedisSerializer());
  7. //		redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer());
  8. 		RedisSerializer stringSerializer = new StringRedisSerializer();
  9. 		Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);
  10. 		ObjectMapper om = new ObjectMapper();
  11. 		om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
  12. 		om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
  13. 		jackson2JsonRedisSerializer.setObjectMapper(om);
  14.  
  15. 		redisTemplate.setKeySerializer(stringSerializer);
  16. 		redisTemplate.setHashKeySerializer(stringSerializer);
  17.  
  18. 		redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
  19. 		redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer);
  20. 		redisTemplate.setConnectionFactory(connectionFactory);
  21. 		return redisTemplate;
  22. 	}
  23. }
2、redis的使用
  1. @PostMapping("/redis/redisSave")
  2.     @ApiOperation("三、redis缓存（1）保存到redis")
  3.     public ResultInfoVo<User> redisSave(String key,String value) {
  4.         redisService.addString(key,value);
  5.         return new ResultInfoVo();
  6.     }
  7.  
  8.     @GetMapping("/redis/redisFind")
  9.     @ApiOperation("三、redis缓存（2）查询redis")
  10.     public ResultInfoVo<User> redisFind(String key) {
  11.         String value = redisService.getString(key);
  12.         return new ResultInfoVo(value);
  13.     }

3、保存和查询截图

四、异常信息

异常信息结构和接口数据返回的数据结构是一致的

如接口返回的结构如下

1、封装对象
  1. @ToString
  2. @ApiModel()
  3. public class ResultInfoVo<T> {
  4.  
  5.     public static final String SUCCESS="success";
  6.     public static final String FAILED="failed";
  7.  
  8.     @ApiModelProperty(value = "业务code：成功为success,失败为其它业务,如roleIdIsNull")
  9.     private String code="success";//业务code 成功为 success  失败为 其它业务编号，如paramIsNull
  10.     @ApiModelProperty(value = "描述信息")
  11.     private String message="处理成功";//描述信息
  12.     @ApiModelProperty(value = "业务数据")
  13.     public T data;//页数据
  14.  
  15.  
  16.     public ResultInfoVo(){}
  17.  
  18.     public ResultInfoVo(T data) {
  19.         this.data = data;
  20.     }
  21.  
  22.     public ResultInfoVo(String message,T data) {
  23.         this.message = message;
  24.         this.data = data;
  25.     }
  26.  
  27.     public ResultInfoVo(String code, String message) {
  28.         this.code = code;
  29.         this.message = message;
  30.     }
  31.  
  32.     public ResultInfoVo( String code, String message, T data) {
  33.         this.code = code;
  34.         this.message = message;
  35.         this.data = data;
  36.     }
  37. }

异常信息返回的对象

  1. public class CKException extends RuntimeException {
  2.     private Log logger = LogFactory.getLog(getClass());
  3.     @ApiModelProperty(value = "业务code：成都为success,失败为其它业务,如roleIdIsNull")
  4.     private String code;//业务错误码
  5.     @ApiModelProperty(value = "描述信息")
  6.     private String message;//错误详情
  7.     @ApiModelProperty(value = "其它数据")
  8.     private Object data;//其它数据
  9.  
  10.  
  11.     public CKException(String code, String message) {
  12.         this.code = code;
  13.         this.message = message;
  14.         this.data=data;
  15.     }
  16.  
  17.  
  18.     public CKException(String code, String message, Object data) {
  19.         this.code = code;
  20.         this.message = message;
  21.         this.data=data;
  22.     }
  23. }

2、使用：

五、接口返回数据格式的封装
  1. package com.ck.server.web.model.vo;
  2.  
  3. import io.swagger.annotations.ApiModel;
  4. import io.swagger.annotations.ApiModelProperty;
  5. import lombok.ToString;
  6.  
  7. /**
  8.  * Created by Administrator on 2018/7/2.
  9.  */
  10. @ToString
  11. @ApiModel()
  12. public class ResultInfoVo<T> {
  13.  
  14.     public static final String SUCCESS="success";
  15.     public static final String FAILED="failed";
  16.  
  17.     @ApiModelProperty(value = "业务code：成功为success,失败为其它业务,如roleIdIsNull")
  18.     private String code="success";//业务code 成功为 success  失败为 其它业务编号，如paramIsNull
  19.     @ApiModelProperty(value = "描述信息")
  20.     private String message="处理成功";//描述信息
  21.     @ApiModelProperty(value = "业务数据")
  22.     public T data;//页数据
  23.  
  24.  
  25.     public ResultInfoVo(){}
  26.  
  27.     public ResultInfoVo(T data) {
  28.         this.data = data;
  29.     }
  30.  
  31.     public ResultInfoVo(String message,T data) {
  32.         this.message = message;
  33.         this.data = data;
  34.     }
  35.  
  36.     public ResultInfoVo(String code, String message) {
  37.         this.code = code;
  38.         this.message = message;
  39.     }
  40.  
  41.     public ResultInfoVo( String code, String message, T data) {
  42.         this.code = code;
  43.         this.message = message;
  44.         this.data = data;
  45.     }
  46.  
  47.     public String getCode() {
  48.         return code;
  49.     }
  50.  
  51.     public void setCode(String code) {
  52.         this.code = code;
  53.     }
  54.  
  55.     public String getMessage() {
  56.         return message;
  57.     }
  58.  
  59.     public void setMessage(String message) {
  60.         this.message = message;
  61.     }
  62.  
  63.     public T getData() {
  64.         return data;
  65.     }
  66.  
  67.     public void setData(T data) {
  68.         this.data = data;
  69.     }
  70. }
六、源代码下载：

链接：https://pan.baidu.com/s/16snuaL2X3oPelNm6uSMv4Q?pwd=dy7p 
提取码：dy7p

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/黑客灵魂/article/detail/817877
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号