refactor: 包结构优化，websocket 重构

2023-12-13 18:33:11 +08:00
parent 28646fdf73
commit cd4f14e643
26 changed files with 160 additions and 159 deletions
--- a/src/main/java/com/youlai/system/config/MybatisConfig.java
+++ b/src/main/java/com/youlai/system/config/MybatisConfig.java
@@ -0,0 +1,48 @@
+package com.youlai.system.config;
+
+import com.baomidou.mybatisplus.annotation.DbType;
+import com.baomidou.mybatisplus.core.config.GlobalConfig;
+import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
+import com.baomidou.mybatisplus.extension.plugins.inner.DataPermissionInterceptor;
+import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
+import com.youlai.system.core.mybatis.handler.MyDataPermissionHandler;
+import com.youlai.system.core.mybatis.handler.MyMetaObjectHandler;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.transaction.annotation.EnableTransactionManagement;
+
+/**
+ * mybatis-plus 配置类
+ *
+ * @author haoxr
+ * @since 2022/7/2
+ */
+@Configuration
+@EnableTransactionManagement
+public class MybatisConfig {
+
+    /**
+     * 分页插件和数据权限插件
+     */
+    @Bean
+    public MybatisPlusInterceptor mybatisPlusInterceptor() {
+        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
+        //数据权限
+        interceptor.addInnerInterceptor(new DataPermissionInterceptor(new MyDataPermissionHandler()));
+        //分页插件
+        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
+
+        return interceptor;
+    }
+
+    /**
+     * 自动填充数据库创建人、创建时间、更新人、更新时间
+     */
+    @Bean
+    public GlobalConfig globalConfig() {
+        GlobalConfig globalConfig = new GlobalConfig();
+        globalConfig.setMetaObjectHandler(new MyMetaObjectHandler());
+        return globalConfig;
+    }
+
+}
--- a/src/main/java/com/youlai/system/config/SecurityConfig.java
+++ b/src/main/java/com/youlai/system/config/SecurityConfig.java
@@ -0,0 +1,103 @@
+package com.youlai.system.config;
+
+import com.youlai.system.common.constant.SecurityConstants;
+import com.youlai.system.core.security.exception.MyAccessDeniedHandler;
+import com.youlai.system.core.security.exception.MyAuthenticationEntryPoint;
+import com.youlai.system.core.security.jwt.JwtTokenFilter;
+import com.youlai.system.filter.VerifyCodeFilter;
+import com.youlai.system.core.security.jwt.JwtTokenProvider;
+import lombok.RequiredArgsConstructor;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.security.authentication.AuthenticationManager;
+import org.springframework.security.config.annotation.authentication.configuration.AuthenticationConfiguration;
+import org.springframework.security.config.annotation.method.configuration.EnableMethodSecurity;
+import org.springframework.security.config.annotation.web.builders.HttpSecurity;
+import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+import org.springframework.security.config.annotation.web.configuration.WebSecurityCustomizer;
+import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
+import org.springframework.security.config.http.SessionCreationPolicy;
+import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
+import org.springframework.security.crypto.password.PasswordEncoder;
+import org.springframework.security.web.SecurityFilterChain;
+import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
+
+/**
+ * Spring Security 权限配置
+ *
+ * @author haoxr
+ * @since 2023/2/17
+ */
+@Configuration
+@EnableWebSecurity
+@EnableMethodSecurity
+@RequiredArgsConstructor
+public class SecurityConfig {
+
+    private final MyAuthenticationEntryPoint authenticationEntryPoint;
+    private final MyAccessDeniedHandler accessDeniedHandler;
+    private final JwtTokenProvider jwtTokenProvider;
+
+    @Bean
+    public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
+        http
+                .authorizeHttpRequests(requestMatcherRegistry ->
+                        requestMatcherRegistry.requestMatchers(SecurityConstants.LOGIN_PATH).permitAll()
+                                .anyRequest().authenticated()
+                )
+                .sessionManagement(configurer -> configurer.sessionCreationPolicy(SessionCreationPolicy.STATELESS))
+                .exceptionHandling(httpSecurityExceptionHandlingConfigurer ->
+                        httpSecurityExceptionHandlingConfigurer
+                                .authenticationEntryPoint(authenticationEntryPoint)
+                                .accessDeniedHandler(accessDeniedHandler)
+                )
+                .csrf(AbstractHttpConfigurer::disable)
+
+        ;
+
+        // 验证码校验过滤器
+        http.addFilterBefore(new VerifyCodeFilter(), UsernamePasswordAuthenticationFilter.class);
+        // JWT 校验过滤器
+        http.addFilterBefore(new JwtTokenFilter(jwtTokenProvider), UsernamePasswordAuthenticationFilter.class);
+
+        return http.build();
+    }
+
+    /**
+     * 不走过滤器链的放行配置
+     */
+    @Bean
+    public WebSecurityCustomizer webSecurityCustomizer() {
+        return (web) -> web.ignoring()
+                .requestMatchers(
+                        "/api/v1/auth/captcha",
+                        "/webjars/**",
+                        "/doc.html",
+                        "/swagger-resources/**",
+                        "/v3/api-docs/**",
+                        "/swagger-ui/**",
+                        "/swagger-ui.html",
+                        "/ws/**",
+                        "/ws-app/**"
+                );
+    }
+
+    /**
+     * 密码编码器
+     */
+    @Bean
+    public PasswordEncoder passwordEncoder() {
+        return new BCryptPasswordEncoder();
+    }
+
+    /**
+     * AuthenticationManager 手动注入
+     *
+     * @param authenticationConfiguration 认证配置
+     */
+    @Bean
+    public AuthenticationManager authenticationManager(AuthenticationConfiguration authenticationConfiguration) throws Exception {
+        return authenticationConfiguration.getAuthenticationManager();
+    }
+
+}
--- a/src/main/java/com/youlai/system/config/WebSocketConfig.java
+++ b/src/main/java/com/youlai/system/config/WebSocketConfig.java
@@ -0,0 +1,111 @@
+package com.youlai.system.config;
+
+import cn.hutool.core.util.StrUtil;
+import com.youlai.system.core.security.jwt.JwtTokenProvider;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.http.HttpHeaders;
+import org.springframework.messaging.Message;
+import org.springframework.messaging.MessageChannel;
+import org.springframework.messaging.simp.config.ChannelRegistration;
+import org.springframework.messaging.simp.config.MessageBrokerRegistry;
+import org.springframework.messaging.simp.stomp.StompCommand;
+import org.springframework.messaging.simp.stomp.StompHeaderAccessor;
+import org.springframework.messaging.support.ChannelInterceptor;
+import org.springframework.messaging.support.MessageHeaderAccessor;
+import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
+import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
+import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;
+
+/**
+ * WebSocket 配置
+ *
+ * @author haoxr
+ * @since 2.4.0
+ */
+@Configuration
+@EnableWebSocketMessageBroker // 启用WebSocket消息代理功能和配置STOMP协议，实现实时双向通信和消息传递
+@RequiredArgsConstructor
+@Slf4j
+public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
+
+    private final JwtTokenProvider jwtTokenProvider;
+
+    /**
+     * 注册一个端点，客户端通过这个端点进行连接
+     */
+    @Override
+    public void registerStompEndpoints(StompEndpointRegistry registry) {
+        registry
+                .addEndpoint("/ws")   // 注册了一个 /ws 的端点
+                .setAllowedOriginPatterns("*") // 允许跨域的 WebSocket 连接
+                .withSockJS();  // 启用 SockJS (浏览器不支持WebSocket，SockJS 将会提供兼容性支持)
+        registry.addEndpoint("/ws-app").setAllowedOriginPatterns("*");  // 注册了一个 /ws-app 的端点，支持 uni-app 的 ws 连接协议
+    }
+
+
+    /**
+     * 配置消息代理
+     */
+    @Override
+    public void configureMessageBroker(MessageBrokerRegistry registry) {
+        // 客户端发送消息的请求前缀
+        registry.setApplicationDestinationPrefixes("/app");
+
+        // 客户端订阅消息的请求前缀，topic一般用于广播推送，queue用于点对点推送
+        registry.enableSimpleBroker("/topic", "/queue");
+
+        // 服务端通知客户端的前缀，可以不设置，默认为user
+        registry.setUserDestinationPrefix("/user");
+    }
+
+
+    /**
+     * 配置客户端入站通道拦截器
+     *
+     * @param registration 通道注册器
+     */
+    @Override
+    public void configureClientInboundChannel(ChannelRegistration registration) {
+        registration.interceptors(new ChannelInterceptor() {
+            @Override
+            public Message<?> preSend(Message<?> message, MessageChannel channel) {
+                StompHeaderAccessor accessor = MessageHeaderAccessor.getAccessor(message, StompHeaderAccessor.class);
+
+                // 如果 StompHeaderAccessor 为 null，说明不是 STOMP 消息，直接放行
+                if (accessor == null) {
+                    return ChannelInterceptor.super.preSend(message, channel);
+                }
+
+                // 如果是连接请求（CONNECT 命令），从请求头中取出 token 并设置到认证信息中
+                if (StompCommand.CONNECT.equals(accessor.getCommand())) {
+                    // 从连接头中提取授权令牌
+                    String bearerToken = accessor.getFirstNativeHeader(HttpHeaders.AUTHORIZATION);
+
+                    // 验证令牌格式并提取用户信息
+                    if (StrUtil.isNotBlank(bearerToken) && bearerToken.startsWith("Bearer ")) {
+                        try {
+                            // 移除 "Bearer " 前缀
+                            String tokenWithoutPrefix = bearerToken.substring(7);
+                            String username = jwtTokenProvider.getUsername(tokenWithoutPrefix);
+
+                            // 如果用户名有效，设置用户到访问器中
+                            if (StrUtil.isNotBlank(username)) {
+                                accessor.setUser(() -> username);
+                                return message;
+                            }
+                        } catch (Exception e) {
+                            // 异常处理，可能是解析令牌失败
+                            log.error("Failed to process authentication token.", e);
+                        }
+                    }
+                }
+
+                // 如果不是连接命令或授权失败，继续执行默认逻辑
+                return ChannelInterceptor.super.preSend(message, channel);
+            }
+        });
+    }
+
+}
--- a/src/main/java/com/youlai/system/config/XxlJobConfig.java
+++ b/src/main/java/com/youlai/system/config/XxlJobConfig.java
@@ -0,0 +1,61 @@
+package com.youlai.system.config;
+
+import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * xxl-job config
+ *
+ * @author xuxueli 2017-04-28
+ */
+@Configuration
+@ConditionalOnProperty(name = "xxl.job.enabled") // xxl.job.enabled = true 才会自动装配
+@Slf4j
+public class XxlJobConfig {
+
+    @Value("${xxl.job.admin.addresses}")
+    private String adminAddresses;
+
+    @Value("${xxl.job.accessToken}")
+    private String accessToken;
+
+    @Value("${xxl.job.executor.appname}")
+    private String appname;
+
+    @Value("${xxl.job.executor.address}")
+    private String address;
+
+    @Value("${xxl.job.executor.ip}")
+    private String ip;
+
+    @Value("${xxl.job.executor.port}")
+    private int port;
+
+    @Value("${xxl.job.executor.logpath}")
+    private String logPath;
+
+    @Value("${xxl.job.executor.logretentiondays}")
+    private int logRetentionDays;
+
+
+    @Bean
+    public XxlJobSpringExecutor xxlJobExecutor() {
+        log.info(">>>>>>>>>>> xxl-job config init.");
+        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
+        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
+        xxlJobSpringExecutor.setAppname(appname);
+        xxlJobSpringExecutor.setAddress(address);
+        xxlJobSpringExecutor.setIp(ip);
+        xxlJobSpringExecutor.setPort(port);
+        xxlJobSpringExecutor.setAccessToken(accessToken);
+        xxlJobSpringExecutor.setLogPath(logPath);
+        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
+
+        return xxlJobSpringExecutor;
+    }
+
+}