├── .gitignore ├── LICENSE ├── README.md ├── mvnw ├── mvnw.cmd ├── pom.xml └── src ├── main ├── java │ ├── com │ │ └── corundumstudio │ │ │ └── socketio │ │ │ ├── spring │ │ │ └── boot │ │ │ │ ├── SocketioHazelcastProperties.java │ │ │ │ ├── SocketioRedisTemplateConfiguration.java │ │ │ │ ├── SocketioRedisTemplateProperties.java │ │ │ │ ├── SocketioRedissonConfiguration.java │ │ │ │ ├── SocketioRedissonProperties.java │ │ │ │ ├── SocketioServerAutoConfiguration.java │ │ │ │ ├── SocketioServerProperties.java │ │ │ │ ├── handler │ │ │ │ └── AbstractSocketEventHandler.java │ │ │ │ ├── hooks │ │ │ │ └── SocketioServerShutdownHook.java │ │ │ │ └── listener │ │ │ │ └── JWTAuthorizationListener.java │ │ │ └── store │ │ │ ├── RedisTemplateMap.java │ │ │ ├── RedisTemplatePubSubStore.java │ │ │ ├── RedisTemplateStore.java │ │ │ └── RedisTemplateStoreFactory.java │ └── org │ │ └── redisson │ │ └── config │ │ └── RedissonConfig.java └── resources │ └── META-INF │ ├── spring-autoconfigure-metadata.properties │ └── spring.factories └── test └── resources ├── application.yml └── log4j.properties /.gitignore: -------------------------------------------------------------------------------- 1 | *# 2 | *.iml 3 | *.ipr 4 | *.iws 5 | *.jar 6 | *.sw? 7 | *~ 8 | .#* 9 | .*.md.html 10 | .apt_generated 11 | .DS_Store 12 | .classpath 13 | .factorypath 14 | .gradle 15 | .idea 16 | .metadata 17 | .project 18 | .recommenders 19 | .settings 20 | .springBeans 21 | .sts4-cache 22 | /build 23 | /code 24 | MANIFEST.MF 25 | _site/ 26 | activemq-data 27 | bin 28 | build 29 | build.log 30 | dependency-reduced-pom.xml 31 | dump.rdb 32 | interpolated*.xml 33 | lib/ 34 | manifest.yml 35 | overridedb.* 36 | settings.xml 37 | target 38 | transaction-logs 39 | .flattened-pom.xml 40 | secrets.yml 41 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # socketio-spring-boot-starter 2 | 3 | 4 | #### 组件简介 5 | 6 | > 基于 [netty-socketio 2.x](https://github.com/mrniko/netty-socketio) 开源项目实现的Socket项目整合 7 | 8 | #### 使用说明 9 | 10 | ##### 1、Spring Boot 项目添加 Maven 依赖 11 | 12 | ``` xml 13 | 14 | com.github.hiwepy 15 | socketio-spring-boot-starter 16 | ${project.version} 17 | 18 | ``` 19 | 20 | ##### 2、在`application.yml`文件中增加如下配置 21 | 22 | ```yaml 23 | ################################################################################################# 24 | ### SocketIO 配置： 25 | ################################################################################################# 26 | socketio: 27 | redis: 28 | redisson: 29 | enabled: true 30 | server: single 31 | single: 32 | address: redis://192.168.2.237:6379 33 | password: redis 34 | client-name: redis 35 | connection-minimum-idle-size: 5 36 | connection-pool-size: 50 37 | template: 38 | enabled: false 39 | # 服务端配置 40 | server: 41 | enabled: true 42 | ## host在本地测试可以设置为localhost或者本机IP，在Linux服务器跑可换成服务器IP 43 | hostname: 192.168.2.222 44 | ## netty启动端口 45 | port: 10065 46 | ## 添加头部版本信息 47 | add-version-header: true 48 | ## Ping消息间隔（毫秒），默认25秒。客户端向服务器发送一条心跳消息间隔 49 | ping-interval: 25000 50 | ## Ping消息超时时间（毫秒），默认60秒，这个时间间隔内没有接收到心跳消息就会发送超时事件 51 | ping-timeout: 60000 52 | ## 设置最大每帧处理数据的长度，防止他人利用大数据来攻击服务器 53 | max-frame-payload-length: 1048576 54 | ## 设置http交互最大内容长度 55 | max-http-content-length: 1048576 56 | ## socket连接数大小（如只监听一个端口boss线程组为1即可） 57 | boss-threads: 1 58 | transports: 59 | - polling 60 | - websocket 61 | worker-threads: 100 62 | ## 协议升级超时时间（毫秒），默认10秒。HTTP握手升级为ws协议超时时间 63 | upgrade-timeout: 15000 64 | ## socket配置 65 | socket-config: 66 | reuse-address: true 67 | tcp-no-delay: true 68 | so-linger: 0 69 | ack-mode: auto 70 | allow-custom-requests: true 71 | ## sessionID 通过请求头io来获取 72 | random-session: false 73 | ``` 74 | 75 | ##### 3、前端示例 76 | 77 | ```html 78 | 79 | 80 | 81 | 82 | Socketio chat 83 | 84 | 85 | 86 | 87 |

Netty-socketio chat demo

88 |
89 |
90 |
91 | 92 | 93 | 94 | 95 | 96 |
97 | 98 | 133 | 155 | 156 | ``` 157 | 158 | ##### 3、如果通过Nginx进行服务负载，需要添加如下配置： 159 | 160 | ```json 161 | location ~ /socket.io { 162 | 163 | proxy_http_version 1.1; 164 | proxy_set_header Upgrade $http_upgrade; 165 | proxy_set_header Connection "upgrade"; 166 | proxy_set_header Host $host; 167 | proxy_buffering off; 168 | 169 | proxy_set_header X-Real-IP $remote_addr; 170 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 171 | proxy_set_header X-Forwarded-Port $server_port; 172 | proxy_set_header X-Nginx-Proxy true; 173 | 174 | proxy_connect_timeout 60s; 175 | proxy_send_timeout 600s; 176 | proxy_read_timeout 600s; 177 | send_timeout 600s; 178 | 179 | proxy_pass http://122.224.247.131:10065; 180 | } 181 | ``` 182 | 183 | ##### 4、如果你的项目使用了uni-app进行移动端开发，需要进行接口对接，可参考如下代码进行 184 | 185 | ```javascript 186 | var socketTask = uni.connectSocket({ 187 | url: 'wss://{your-domain}/socket.io/?transport=websocket', 188 | header: { 189 | 'X-Authorization' : token, 190 | 'io' : 'test' 191 | }, 192 | success: (res)=> { 193 | console.log(res); 194 | }, 195 | fail: (res)=> { 196 | console.log(res); 197 | }, 198 | complete: ()=> { 199 | } 200 | }); 201 | uni.onSocketOpen(function (res) { 202 | console.log('WebSocket连接已打开！'); 203 | }); 204 | uni.onSocketError(function (res) { 205 | console.log(res,'WebSocket连接打开失败，请检查！'); 206 | }); 207 | uni.onSocketMessage(function (res) { 208 | console.log('收到服务器内容：' + res.data); 209 | }); 210 | uni.onSocketClose(function (res) { 211 | console.log(res, 'WebSocket 已关闭！'); 212 | }); 213 | ``` 214 | 215 | #### 代码示例 216 | 217 | [https://github.com/hiwepy/spring-boot-starter-samples/tree/master/spring-boot-sample-socketio](https://github.com/hiwepy/spring-boot-starter-samples/tree/master/spring-boot-sample-socketio "spring-boot-sample-socketio") 218 | 219 | ## Jeebiz 技术社区 220 | 221 | Jeebiz 技术社区 **微信公共号**、**小程序**，欢迎关注反馈意见和一起交流，关注公众号回复「Jeebiz」拉你入群。 222 | 223 | |公共号|小程序| 224 | |---|---| 225 | | ![](https://raw.githubusercontent.com/hiwepy/static/main/images/qrcode_for_gh_1d965ea2dfd1_344.jpg)| ![](https://raw.githubusercontent.com/hiwepy/static/main/images/gh_09d7d00da63e_344.jpg)| 226 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven2 Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /etc/mavenrc ] ; then 40 | . /etc/mavenrc 41 | fi 42 | 43 | if [ -f "$HOME/.mavenrc" ] ; then 44 | . "$HOME/.mavenrc" 45 | fi 46 | 47 | fi 48 | 49 | # OS specific support. $var _must_ be set to either true or false. 50 | cygwin=false; 51 | darwin=false; 52 | mingw=false 53 | case "`uname`" in 54 | CYGWIN*) cygwin=true ;; 55 | MINGW*) mingw=true;; 56 | Darwin*) darwin=true 57 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 58 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 59 | if [ -z "$JAVA_HOME" ]; then 60 | if [ -x "/usr/libexec/java_home" ]; then 61 | export JAVA_HOME="`/usr/libexec/java_home`" 62 | else 63 | export JAVA_HOME="/Library/Java/Home" 64 | fi 65 | fi 66 | ;; 67 | esac 68 | 69 | if [ -z "$JAVA_HOME" ] ; then 70 | if [ -r /etc/gentoo-release ] ; then 71 | JAVA_HOME=`java-config --jre-home` 72 | fi 73 | fi 74 | 75 | if [ -z "$M2_HOME" ] ; then 76 | ## resolve links - $0 may be a link to maven's home 77 | PRG="$0" 78 | 79 | # need this for relative symlinks 80 | while [ -h "$PRG" ] ; do 81 | ls=`ls -ld "$PRG"` 82 | link=`expr "$ls" : '.*-> \(.*\)$'` 83 | if expr "$link" : '/.*' > /dev/null; then 84 | PRG="$link" 85 | else 86 | PRG="`dirname "$PRG"`/$link" 87 | fi 88 | done 89 | 90 | saveddir=`pwd` 91 | 92 | M2_HOME=`dirname "$PRG"`/.. 93 | 94 | # make it fully qualified 95 | M2_HOME=`cd "$M2_HOME" && pwd` 96 | 97 | cd "$saveddir" 98 | # echo Using m2 at $M2_HOME 99 | fi 100 | 101 | # For Cygwin, ensure paths are in UNIX format before anything is touched 102 | if $cygwin ; then 103 | [ -n "$M2_HOME" ] && 104 | M2_HOME=`cygpath --unix "$M2_HOME"` 105 | [ -n "$JAVA_HOME" ] && 106 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 107 | [ -n "$CLASSPATH" ] && 108 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 109 | fi 110 | 111 | # For Migwn, ensure paths are in UNIX format before anything is touched 112 | if $mingw ; then 113 | [ -n "$M2_HOME" ] && 114 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 115 | [ -n "$JAVA_HOME" ] && 116 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 117 | # TODO classpath? 118 | fi 119 | 120 | if [ -z "$JAVA_HOME" ]; then 121 | javaExecutable="`which javac`" 122 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 123 | # readlink(1) is not available as standard on Solaris 10. 124 | readLink=`which readlink` 125 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 126 | if $darwin ; then 127 | javaHome="`dirname \"$javaExecutable\"`" 128 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 129 | else 130 | javaExecutable="`readlink -f \"$javaExecutable\"`" 131 | fi 132 | javaHome="`dirname \"$javaExecutable\"`" 133 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 134 | JAVA_HOME="$javaHome" 135 | export JAVA_HOME 136 | fi 137 | fi 138 | fi 139 | 140 | if [ -z "$JAVACMD" ] ; then 141 | if [ -n "$JAVA_HOME" ] ; then 142 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 143 | # IBM's JDK on AIX uses strange locations for the executables 144 | JAVACMD="$JAVA_HOME/jre/sh/java" 145 | else 146 | JAVACMD="$JAVA_HOME/bin/java" 147 | fi 148 | else 149 | JAVACMD="`which java`" 150 | fi 151 | fi 152 | 153 | if [ ! -x "$JAVACMD" ] ; then 154 | echo "Error: JAVA_HOME is not defined correctly." >&2 155 | echo " We cannot execute $JAVACMD" >&2 156 | exit 1 157 | fi 158 | 159 | if [ -z "$JAVA_HOME" ] ; then 160 | echo "Warning: JAVA_HOME environment variable is not set." 161 | fi 162 | 163 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 164 | 165 | # traverses directory structure from process work directory to filesystem root 166 | # first directory with .mvn subdirectory is considered project base directory 167 | find_maven_basedir() { 168 | 169 | if [ -z "$1" ] 170 | then 171 | echo "Path not specified to find_maven_basedir" 172 | return 1 173 | fi 174 | 175 | basedir="$1" 176 | wdir="$1" 177 | while [ "$wdir" != '/' ] ; do 178 | if [ -d "$wdir"/.mvn ] ; then 179 | basedir=$wdir 180 | break 181 | fi 182 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 183 | if [ -d "${wdir}" ]; then 184 | wdir=`cd "$wdir/.."; pwd` 185 | fi 186 | # end of workaround 187 | done 188 | echo "${basedir}" 189 | } 190 | 191 | # concatenates all lines of a file 192 | concat_lines() { 193 | if [ -f "$1" ]; then 194 | echo "$(tr -s '\n' ' ' < "$1")" 195 | fi 196 | } 197 | 198 | BASE_DIR=`find_maven_basedir "$(pwd)"` 199 | if [ -z "$BASE_DIR" ]; then 200 | exit 1; 201 | fi 202 | 203 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 204 | echo $MAVEN_PROJECTBASEDIR 205 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 206 | 207 | # For Cygwin, switch paths to Windows format before running java 208 | if $cygwin; then 209 | [ -n "$M2_HOME" ] && 210 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 211 | [ -n "$JAVA_HOME" ] && 212 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 213 | [ -n "$CLASSPATH" ] && 214 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 215 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 216 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 217 | fi 218 | 219 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 220 | 221 | exec "$JAVACMD" \ 222 | $MAVEN_OPTS \ 223 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 224 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 225 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 226 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM http://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven2 Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' 39 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 40 | 41 | @REM set %HOME% to equivalent of $HOME 42 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 43 | 44 | @REM Execute a user defined script before this one 45 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 46 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 47 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" 48 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" 49 | :skipRcPre 50 | 51 | @setlocal 52 | 53 | set ERROR_CODE=0 54 | 55 | @REM To isolate internal variables from possible post scripts, we use another setlocal 56 | @setlocal 57 | 58 | @REM ==== START VALIDATION ==== 59 | if not "%JAVA_HOME%" == "" goto OkJHome 60 | 61 | echo. 62 | echo Error: JAVA_HOME not found in your environment. >&2 63 | echo Please set the JAVA_HOME variable in your environment to match the >&2 64 | echo location of your Java installation. >&2 65 | echo. 66 | goto error 67 | 68 | :OkJHome 69 | if exist "%JAVA_HOME%\bin\java.exe" goto init 70 | 71 | echo. 72 | echo Error: JAVA_HOME is set to an invalid directory. >&2 73 | echo JAVA_HOME = "%JAVA_HOME%" >&2 74 | echo Please set the JAVA_HOME variable in your environment to match the >&2 75 | echo location of your Java installation. >&2 76 | echo. 77 | goto error 78 | 79 | @REM ==== END VALIDATION ==== 80 | 81 | :init 82 | 83 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 84 | @REM Fallback to current working directory if not found. 85 | 86 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 87 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 88 | 89 | set EXEC_DIR=%CD% 90 | set WDIR=%EXEC_DIR% 91 | :findBaseDir 92 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 93 | cd .. 94 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 95 | set WDIR=%CD% 96 | goto findBaseDir 97 | 98 | :baseDirFound 99 | set MAVEN_PROJECTBASEDIR=%WDIR% 100 | cd "%EXEC_DIR%" 101 | goto endDetectBaseDir 102 | 103 | :baseDirNotFound 104 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 105 | cd "%EXEC_DIR%" 106 | 107 | :endDetectBaseDir 108 | 109 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 110 | 111 | @setlocal EnableExtensions EnableDelayedExpansion 112 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 113 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 114 | 115 | :endReadAdditionalConfig 116 | 117 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 118 | 119 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 120 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 121 | 122 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 123 | if ERRORLEVEL 1 goto error 124 | goto end 125 | 126 | :error 127 | set ERROR_CODE=1 128 | 129 | :end 130 | @endlocal & set ERROR_CODE=%ERROR_CODE% 131 | 132 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost 133 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 134 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" 135 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" 136 | :skipRcPost 137 | 138 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 139 | if "%MAVEN_BATCH_PAUSE%" == "on" pause 140 | 141 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% 142 | 143 | exit /B %ERROR_CODE% 144 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | 7 | org.springframework.boot 8 | spring-boot-starter-parent 9 | 2.6.0 10 | 11 | 12 | 13 | com.github.hiwepy 14 | socketio-spring-boot-starter 15 | Spring Boot Starter For Netty-socketio 16 | 2.0.1-SNAPSHOT 17 | ${project.groupId}:${project.artifactId} 18 | https://github.com/hiwepy/${project.artifactId} 19 | jar 20 | 21 | 22 | 23 | The Apache Software License, Version 2.0 24 | http://www.apache.org/licenses/LICENSE-2.0.txt 25 | 26 | 27 | 28 | 29 | scm:git:https:github.com/hiwepy/${project.artifactId}.git 30 | scm:git:https:github.com/hiwepy/${project.artifactId}.git 31 | https:github.com/hiwepy/${project.artifactId} 32 | ${project.artifactId} 33 | 34 | 35 | 36 | 37 | wandl 38 | hnxyhcwdl1003@163.com 39 | 40 | developer 41 | 42 | +8 43 | 44 | 45 | 46 | 47 | 48 | 49 | ossrh 50 | Maven Snapshots Repository 51 | https://oss.sonatype.org/content/repositories/snapshots 52 | 53 | 54 | ossrh 55 | Maven Central Staging Repository 56 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | org.apache.maven.plugins 66 | maven-compiler-plugin 67 | ${maven-compiler-plugin.version} 68 | 69 | ${java.version} 70 | ${java.version} 71 | ${project.build.sourceEncoding} 72 | 512M 73 | 74 | 75 | 76 | 77 | org.apache.maven.plugins 78 | maven-enforcer-plugin 79 | ${maven-enforcer-plugin.version} 80 | 81 | 82 | default-cli 83 | 84 | enforce 85 | 86 | validate 87 | 88 | 89 | 90 | 91 | 92 | 93 | [${maven.version}.0,) 94 | 95 | 96 | 97 | 98 | 99 | [${java.version}.0,) 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | org.apache.maven.plugins 109 | maven-gpg-plugin 110 | ${maven-gpg-plugin.version} 111 | 112 | 113 | sign-artifacts 114 | verify 115 | 116 | sign 117 | 118 | 119 | 120 | 121 | 122 | 123 | org.apache.maven.plugins 124 | maven-resources-plugin 125 | ${maven-resources-plugin.version} 126 | 127 | ${project.build.sourceEncoding} 128 | 129 | 130 | 131 | 132 | org.apache.maven.plugins 133 | maven-release-plugin 134 | ${maven-release-plugin.version} 135 | 136 | v@{project.version} 137 | true 138 | false 139 | release 140 | deploy 141 | 142 | 143 | 144 | 145 | org.apache.maven.plugins 146 | maven-source-plugin 147 | ${maven-source-plugin.version} 148 | 149 | true 150 | 151 | 152 | 153 | attach-sources 154 | 155 | jar-no-fork 156 | 157 | 158 | 159 | 160 | 161 | 162 | org.apache.maven.plugins 163 | maven-surefire-plugin 164 | ${maven-surefire-plugin.version} 165 | 166 | 167 | true 168 | true 169 | 172 | once 173 | -Xmx1024m -XX:PermSize=256m -XX:MaxPermSize=256m -Dfile.encoding=UTF-8 174 | 175 | ${basedir}/target/test-classes 176 | 177 | 178 | **/*Test.java 179 | 180 | 181 | **/TestBean.java 182 | 183 | 184 | 185 | 186 | 187 | org.apache.maven.plugins 188 | maven-jar-plugin 189 | ${maven-jar-plugin.version} 190 | 191 | true 192 | 193 | 194 | true 195 | true 196 | 197 | 198 | 199 | 200 | 201 | 202 | org.apache.maven.plugins 203 | maven-javadoc-plugin 204 | ${maven-javadoc-plugin.version} 205 | 206 | ${project.build.sourceEncoding} 207 | ${project.build.sourceEncoding} 208 | ${project.build.sourceEncoding} 209 | 210 | 211 | 212 | attach-javadocs 213 | package 214 | 215 | jar 216 | 217 | 218 | 219 | 220 | 221 | org.sonatype.plugins 222 | nexus-staging-maven-plugin 223 | ${maven-nexus-staging-plugin.version} 224 | true 225 | 226 | ossrh 227 | https://oss.sonatype.org/ 228 | true 229 | 230 | 60 231 | 20 232 | true 233 | 234 | 235 | 236 | 237 | 238 | 239 | 240 | org.apache.maven.plugins 241 | maven-enforcer-plugin 242 | 243 | 244 | 245 | org.apache.maven.plugins 246 | maven-compiler-plugin 247 | 248 | 249 | 250 | org.apache.maven.plugins 251 | maven-resources-plugin 252 | 253 | 254 | 255 | org.apache.maven.plugins 256 | maven-surefire-plugin 257 | 258 | 259 | 260 | org.apache.maven.plugins 261 | maven-jar-plugin 262 | 263 | 264 | 265 | org.apache.maven.plugins 266 | maven-source-plugin 267 | 268 | 269 | 270 | org.apache.maven.plugins 271 | maven-install-plugin 272 | 273 | 274 | 275 | org.apache.maven.plugins 276 | maven-deploy-plugin 277 | 278 | 279 | 280 | 281 | 282 | 283 | disable-javadoc-doclint 284 | 285 | [1.8,) 286 | 287 | 288 | -Xdoclint:none 289 | 290 | 291 | 292 | release 293 | 294 | 295 | 296 | 297 | org.apache.maven.plugins 298 | maven-enforcer-plugin 299 | 300 | 301 | 302 | org.apache.maven.plugins 303 | maven-compiler-plugin 304 | 305 | 306 | 307 | org.apache.maven.plugins 308 | maven-resources-plugin 309 | 310 | 311 | 312 | org.apache.maven.plugins 313 | maven-surefire-plugin 314 | 315 | 316 | 317 | org.apache.maven.plugins 318 | maven-jar-plugin 319 | 320 | 321 | 322 | org.apache.maven.plugins 323 | maven-source-plugin 324 | 325 | 326 | 327 | org.apache.maven.plugins 328 | maven-javadoc-plugin 329 | 330 | 331 | 332 | org.apache.maven.plugins 333 | maven-install-plugin 334 | 335 | 336 | 337 | org.apache.maven.plugins 338 | maven-gpg-plugin 339 | 340 | 341 | 342 | org.apache.maven.plugins 343 | maven-deploy-plugin 344 | 345 | 346 | 347 | org.apache.maven.plugins 348 | maven-release-plugin 349 | 350 | 351 | org.sonatype.plugins 352 | nexus-staging-maven-plugin 353 | 354 | 355 | 356 | 357 | 358 | 359 | 360 | UTF-8 361 | UTF-8 362 | 3.0 363 | 1.6 364 | 3.1.1 365 | 2.5.3 366 | 3.1.0 367 | 2.22.1 368 | 1.6.8 369 | 2.0.9 370 | 3.17.7 371 | 372 | 373 | 374 | 375 | 376 | 377 | javax.servlet 378 | javax.servlet-api 379 | true 380 | 381 | 382 | 383 | org.slf4j 384 | slf4j-api 385 | 386 | 387 | 388 | org.slf4j 389 | slf4j-simple 390 | test 391 | 392 | 393 | 394 | 395 | org.springframework.boot 396 | spring-boot-starter 397 | 398 | 399 | org.springframework.boot 400 | spring-boot-starter-logging 401 | 402 | 403 | 404 | 405 | 406 | org.springframework.boot 407 | spring-boot-starter-test 408 | test 409 | 410 | 411 | 412 | org.springframework.boot 413 | spring-boot-configuration-processor 414 | true 415 | 416 | 417 | 418 | org.springframework.boot 419 | spring-boot-autoconfigure 420 | 421 | 422 | 423 | 424 | com.corundumstudio.socketio 425 | netty-socketio 426 | ${netty-socketio.version} 427 | 428 | 429 | 430 | 431 | org.redisson 432 | redisson 433 | ${redisson.version} 434 | provided 435 | 436 | 437 | 438 | org.springframework.boot 439 | spring-boot-starter-data-redis 440 | provided 441 | 442 | 443 | org.apache.commons 444 | commons-pool2 445 | provided 446 | 447 | 448 | 449 | 450 | 451 | -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/spring/boot/SocketioHazelcastProperties.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010-2020, hiwepy (https://github.com/hiwepy). 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 | * use this file except in compliance with the License. You may obtain a copy of 6 | * the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | * License for the specific language governing permissions and limitations under 14 | * the License. 15 | */ 16 | package com.corundumstudio.socketio.spring.boot; 17 | 18 | import org.springframework.boot.context.properties.ConfigurationProperties; 19 | 20 | import com.hazelcast.client.config.ClientConfig; 21 | 22 | @ConfigurationProperties(SocketioHazelcastProperties.PREFIX) 23 | public class SocketioHazelcastProperties extends ClientConfig { 24 | 25 | public static final String PREFIX = "socketio.hazelcast"; 26 | 27 | /** 28 | * Enable Socketio Hazelcast Store . 29 | */ 30 | private boolean enabled = false; 31 | 32 | public boolean isEnabled() { 33 | return enabled; 34 | } 35 | 36 | public void setEnabled(boolean enabled) { 37 | this.enabled = enabled; 38 | } 39 | 40 | } 41 | -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/spring/boot/SocketioRedisTemplateConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.corundumstudio.socketio.spring.boot; 2 | 3 | import java.io.IOException; 4 | import java.net.UnknownHostException; 5 | 6 | import org.springframework.boot.autoconfigure.AutoConfigureAfter; 7 | import org.springframework.boot.autoconfigure.AutoConfigureBefore; 8 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; 9 | import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration; 10 | import org.springframework.boot.context.properties.EnableConfigurationProperties; 11 | import org.springframework.context.annotation.Bean; 12 | import org.springframework.context.annotation.Configuration; 13 | import org.springframework.data.redis.connection.RedisConnectionFactory; 14 | import org.springframework.data.redis.core.RedisTemplate; 15 | import org.springframework.data.redis.listener.RedisMessageListenerContainer; 16 | import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer; 17 | import org.springframework.data.redis.serializer.RedisSerializer; 18 | 19 | import com.corundumstudio.socketio.store.RedisTemplateStoreFactory; 20 | import com.corundumstudio.socketio.store.StoreFactory; 21 | import com.fasterxml.jackson.annotation.JsonAutoDetect; 22 | import com.fasterxml.jackson.annotation.PropertyAccessor; 23 | import com.fasterxml.jackson.databind.ObjectMapper; 24 | 25 | @Configuration 26 | @AutoConfigureAfter(RedisAutoConfiguration.class) 27 | @AutoConfigureBefore({ SocketioServerAutoConfiguration.class}) 28 | @ConditionalOnProperty(prefix = SocketioRedisTemplateProperties.PREFIX, value = "enabled", havingValue = "true") 29 | @EnableConfigurationProperties({ SocketioRedisTemplateProperties.class }) 30 | public class SocketioRedisTemplateConfiguration { 31 | 32 | public RedisTemplate socketIoRedisTemplate(RedisConnectionFactory connectionFactory) throws UnknownHostException { 33 | RedisTemplate redisTemplate = new RedisTemplate<>(); 34 | redisTemplate.setConnectionFactory(connectionFactory); 35 | 36 | // 使用Jackson2JsonRedisSerialize 替换默认序列化 37 | Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class); 38 | 39 | ObjectMapper objectMapper = new ObjectMapper(); 40 | // 指定要序列化的域，field,get和set,以及修饰符范围，ANY是都有包括private和public 41 | objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); 42 | // 指定序列化输入的类型，类必须是非final修饰的，final修饰的类，比如String,Integer等会跑出异常 43 | objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL); 44 | 45 | jackson2JsonRedisSerializer.setObjectMapper(objectMapper); 46 | 47 | // 设置value的序列化规则和 key的序列化规则 48 | 49 | // 使用StringRedisSerializer来序列化和反序列化redis的key值 50 | redisTemplate.setKeySerializer(RedisSerializer.string()); 51 | // 值采用json序列化 52 | redisTemplate.setValueSerializer(jackson2JsonRedisSerializer); 53 | 54 | // 设置hash key 和value序列化模式 55 | redisTemplate.setHashKeySerializer(RedisSerializer.string()); 56 | redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer); 57 | redisTemplate.afterPropertiesSet(); 58 | 59 | return redisTemplate; 60 | } 61 | 62 | public RedisMessageListenerContainer socketIoRedisMessageListenerContainer(RedisConnectionFactory connectionFactory) { 63 | RedisMessageListenerContainer container = new RedisMessageListenerContainer(); 64 | container.setConnectionFactory(connectionFactory); 65 | // 序列化对象（特别注意：发布的时候需要设置序列化；订阅方也需要设置序列化） 66 | container.setTopicSerializer(RedisSerializer.string()); 67 | return container; 68 | } 69 | 70 | @Bean 71 | public StoreFactory clientStoreFactory(RedisConnectionFactory connectionFactory) throws IOException { 72 | return new RedisTemplateStoreFactory(socketIoRedisTemplate(connectionFactory), socketIoRedisMessageListenerContainer(connectionFactory)); 73 | } 74 | 75 | } 76 | -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/spring/boot/SocketioRedisTemplateProperties.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010-2020, hiwepy (https://github.com/hiwepy). 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 | * use this file except in compliance with the License. You may obtain a copy of 6 | * the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | * License for the specific language governing permissions and limitations under 14 | * the License. 15 | */ 16 | package com.corundumstudio.socketio.spring.boot; 17 | 18 | import org.springframework.boot.context.properties.ConfigurationProperties; 19 | 20 | @ConfigurationProperties(SocketioRedisTemplateProperties.PREFIX) 21 | public class SocketioRedisTemplateProperties { 22 | 23 | public static final String PREFIX = "socketio.redis.template"; 24 | 25 | /** 26 | * Enable Socketio Redis Store With RedisTemplate. 27 | */ 28 | private boolean enabled = false; 29 | 30 | public boolean isEnabled() { 31 | return enabled; 32 | } 33 | 34 | public void setEnabled(boolean enabled) { 35 | this.enabled = enabled; 36 | } 37 | 38 | } 39 | -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/spring/boot/SocketioRedissonConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.corundumstudio.socketio.spring.boot; 2 | 3 | import org.redisson.Redisson; 4 | import org.redisson.client.codec.Codec; 5 | import org.redisson.codec.JsonJacksonCodec; 6 | import org.redisson.config.Config; 7 | import org.redisson.config.RedissonConfig; 8 | import org.redisson.connection.AddressResolverGroupFactory; 9 | import org.redisson.connection.DnsAddressResolverGroupFactory; 10 | import org.springframework.beans.factory.annotation.Autowired; 11 | import org.springframework.boot.autoconfigure.AutoConfigureBefore; 12 | import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; 13 | import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; 14 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; 15 | import org.springframework.boot.context.properties.EnableConfigurationProperties; 16 | import org.springframework.context.annotation.Bean; 17 | import org.springframework.context.annotation.Configuration; 18 | 19 | import com.corundumstudio.socketio.store.RedissonStoreFactory; 20 | import com.corundumstudio.socketio.store.StoreFactory; 21 | 22 | import io.netty.channel.EventLoopGroup; 23 | 24 | @Configuration 25 | @AutoConfigureBefore({ SocketioServerAutoConfiguration.class}) 26 | @ConditionalOnClass({ Redisson.class }) 27 | @ConditionalOnProperty(prefix = SocketioRedissonProperties.PREFIX, value = "enabled", havingValue = "true") 28 | @EnableConfigurationProperties({ SocketioRedissonProperties.class }) 29 | public class SocketioRedissonConfiguration { 30 | 31 | @Bean 32 | @ConditionalOnMissingBean 33 | public Codec codec() { 34 | return new JsonJacksonCodec(); 35 | } 36 | 37 | /** 38 | * AddressResolverGroupFactory switch between default and round robin 39 | */ 40 | @Bean 41 | @ConditionalOnMissingBean 42 | public AddressResolverGroupFactory addressResolverGroupFactory() { 43 | return new DnsAddressResolverGroupFactory(); 44 | } 45 | 46 | @Bean 47 | public Config redissonConfig(SocketioRedissonProperties properties, 48 | AddressResolverGroupFactory addressResolverGroupFactory, 49 | Codec codec, 50 | @Autowired(required = false) EventLoopGroup eventLoopGroup) { 51 | 52 | RedissonConfig config = new RedissonConfig(properties.getCluster(), 53 | properties.getMasterSlave(), 54 | properties.getReplicated(), 55 | properties.getSentinel(), 56 | properties.getSingle()); 57 | 58 | config.setAddressResolverGroupFactory(addressResolverGroupFactory); 59 | config.setCodec(codec); 60 | config.setEventLoopGroup(eventLoopGroup); 61 | config.setKeepPubSubOrder(properties.isKeepPubSubOrder()); 62 | config.setLockWatchdogTimeout(properties.getLockWatchdogTimeout()); 63 | config.setMaxCleanUpDelay(properties.getMaxCleanUpDelay()); 64 | config.setMinCleanUpDelay(properties.getMinCleanUpDelay()); 65 | config.setNettyThreads(properties.getNettyThreads()); 66 | config.setReferenceEnabled(properties.isReferenceEnabled()); 67 | config.setThreads(properties.getThreads()); 68 | config.setTransportMode(properties.getTransportMode()); 69 | config.setUseScriptCache(properties.isUseScriptCache()); 70 | // 根据服务模式检查配置 71 | switch (properties.getServer()) { 72 | case CLUSTER: { 73 | config.useClusterServers(); 74 | };break; 75 | case MASTERSLAVE: { 76 | config.useMasterSlaveServers(); 77 | };break; 78 | case REPLICATED: { 79 | config.useReplicatedServers(); 80 | };break; 81 | case SENTINEL: { 82 | config.useSentinelServers(); 83 | };break; 84 | default: { 85 | config.useSingleServer(); 86 | };break; 87 | } 88 | 89 | return config; 90 | } 91 | 92 | @Bean(destroyMethod = "shutdown") 93 | @ConditionalOnMissingBean 94 | public Redisson redissonClient(Config redissonConfig) { 95 | return (Redisson) Redisson.create(redissonConfig); 96 | } 97 | 98 | @Bean(destroyMethod = "shutdown") 99 | @ConditionalOnMissingBean 100 | public Redisson redissonPub(Config redissonConfig) { 101 | return (Redisson) Redisson.create(redissonConfig); 102 | } 103 | 104 | @Bean(destroyMethod = "shutdown") 105 | @ConditionalOnMissingBean 106 | public Redisson redissonSub(Config redissonConfig) { 107 | return (Redisson) Redisson.create(redissonConfig); 108 | } 109 | 110 | @Bean 111 | public StoreFactory clientStoreFactory(Redisson redisClient, Redisson redisPub, Redisson redisSub) { 112 | return new RedissonStoreFactory(redisClient, redisPub, redisSub); 113 | } 114 | 115 | } 116 | -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/spring/boot/SocketioRedissonProperties.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010-2020, hiwepy (https://github.com/hiwepy). 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 | * use this file except in compliance with the License. You may obtain a copy of 6 | * the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | * License for the specific language governing permissions and limitations under 14 | * the License. 15 | */ 16 | package com.corundumstudio.socketio.spring.boot; 17 | 18 | import org.redisson.config.ClusterServersConfig; 19 | import org.redisson.config.MasterSlaveServersConfig; 20 | import org.redisson.config.ReplicatedServersConfig; 21 | import org.redisson.config.SentinelServersConfig; 22 | import org.redisson.config.SingleServerConfig; 23 | import org.redisson.config.TransportMode; 24 | import org.springframework.boot.context.properties.ConfigurationProperties; 25 | 26 | @ConfigurationProperties(SocketioRedissonProperties.PREFIX) 27 | public class SocketioRedissonProperties { 28 | 29 | public static final String PREFIX = "socketio.redis.redisson"; 30 | 31 | public enum RedisServerMode { 32 | 33 | /** 34 | * Cluster Mode. 35 | */ 36 | CLUSTER, 37 | /** 38 | * Master Slave Mode 39 | */ 40 | MASTERSLAVE, 41 | /** 42 | * Replicated Mode 43 | */ 44 | REPLICATED, 45 | /** 46 | * Sentinel Mode 47 | */ 48 | SENTINEL, 49 | /** 50 | * Single Mode 51 | */ 52 | SINGLE, 53 | 54 | } 55 | 56 | /** 57 | * Enable Socketio Redis Store With Redisson. 58 | */ 59 | private boolean enabled = false; 60 | 61 | /** 62 | * Threads amount shared between all redis node clients 63 | */ 64 | private int threads = 16; 65 | 66 | private int nettyThreads = 32; 67 | 68 | /** 69 | * Config option for enabling Redisson Reference feature. Default value is TRUE 70 | */ 71 | private boolean referenceEnabled = true; 72 | 73 | private TransportMode transportMode = TransportMode.NIO; 74 | 75 | private RedisServerMode server = RedisServerMode.SINGLE; 76 | 77 | private long lockWatchdogTimeout = 30 * 1000; 78 | 79 | private boolean keepPubSubOrder = true; 80 | 81 | private boolean decodeInExecutor = false; 82 | 83 | private boolean useScriptCache = false; 84 | 85 | private int minCleanUpDelay = 5; 86 | private int maxCleanUpDelay = 30 * 60; 87 | 88 | private SentinelServersConfig sentinel; 89 | 90 | private MasterSlaveServersConfig masterSlave; 91 | 92 | private SingleServerConfig single; 93 | 94 | private ClusterServersConfig cluster; 95 | 96 | private ReplicatedServersConfig replicated; 97 | 98 | public boolean isEnabled() { 99 | return enabled; 100 | } 101 | 102 | public void setEnabled(boolean enabled) { 103 | this.enabled = enabled; 104 | } 105 | 106 | public int getThreads() { 107 | return threads; 108 | } 109 | 110 | public void setThreads(int threads) { 111 | this.threads = threads; 112 | } 113 | 114 | public int getNettyThreads() { 115 | return nettyThreads; 116 | } 117 | 118 | public void setNettyThreads(int nettyThreads) { 119 | this.nettyThreads = nettyThreads; 120 | } 121 | 122 | public boolean isReferenceEnabled() { 123 | return referenceEnabled; 124 | } 125 | 126 | public void setReferenceEnabled(boolean referenceEnabled) { 127 | this.referenceEnabled = referenceEnabled; 128 | } 129 | 130 | public TransportMode getTransportMode() { 131 | return transportMode; 132 | } 133 | 134 | public void setTransportMode(TransportMode transportMode) { 135 | this.transportMode = transportMode; 136 | } 137 | 138 | public RedisServerMode getServer() { 139 | return server; 140 | } 141 | 142 | public void setServer(RedisServerMode server) { 143 | this.server = server; 144 | } 145 | 146 | public long getLockWatchdogTimeout() { 147 | return lockWatchdogTimeout; 148 | } 149 | 150 | public void setLockWatchdogTimeout(long lockWatchdogTimeout) { 151 | this.lockWatchdogTimeout = lockWatchdogTimeout; 152 | } 153 | 154 | public boolean isKeepPubSubOrder() { 155 | return keepPubSubOrder; 156 | } 157 | 158 | public void setKeepPubSubOrder(boolean keepPubSubOrder) { 159 | this.keepPubSubOrder = keepPubSubOrder; 160 | } 161 | 162 | public boolean isDecodeInExecutor() { 163 | return decodeInExecutor; 164 | } 165 | 166 | public void setDecodeInExecutor(boolean decodeInExecutor) { 167 | this.decodeInExecutor = decodeInExecutor; 168 | } 169 | 170 | public boolean isUseScriptCache() { 171 | return useScriptCache; 172 | } 173 | 174 | public void setUseScriptCache(boolean useScriptCache) { 175 | this.useScriptCache = useScriptCache; 176 | } 177 | 178 | public int getMinCleanUpDelay() { 179 | return minCleanUpDelay; 180 | } 181 | 182 | public void setMinCleanUpDelay(int minCleanUpDelay) { 183 | this.minCleanUpDelay = minCleanUpDelay; 184 | } 185 | 186 | public int getMaxCleanUpDelay() { 187 | return maxCleanUpDelay; 188 | } 189 | 190 | public void setMaxCleanUpDelay(int maxCleanUpDelay) { 191 | this.maxCleanUpDelay = maxCleanUpDelay; 192 | } 193 | 194 | public SentinelServersConfig getSentinel() { 195 | return sentinel; 196 | } 197 | 198 | public void setSentinel(SentinelServersConfig sentinel) { 199 | this.sentinel = sentinel; 200 | } 201 | 202 | public MasterSlaveServersConfig getMasterSlave() { 203 | return masterSlave; 204 | } 205 | 206 | public void setMasterSlave(MasterSlaveServersConfig masterSlave) { 207 | this.masterSlave = masterSlave; 208 | } 209 | 210 | public SingleServerConfig getSingle() { 211 | return single; 212 | } 213 | 214 | public void setSingle(SingleServerConfig single) { 215 | this.single = single; 216 | } 217 | 218 | public ClusterServersConfig getCluster() { 219 | return cluster; 220 | } 221 | 222 | public void setCluster(ClusterServersConfig cluster) { 223 | this.cluster = cluster; 224 | } 225 | 226 | public ReplicatedServersConfig getReplicated() { 227 | return replicated; 228 | } 229 | 230 | public void setReplicated(ReplicatedServersConfig replicated) { 231 | this.replicated = replicated; 232 | } 233 | 234 | } 235 | -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/spring/boot/SocketioServerAutoConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.corundumstudio.socketio.spring.boot; 2 | 3 | import org.slf4j.Logger; 4 | import org.slf4j.LoggerFactory; 5 | import org.springframework.beans.factory.DisposableBean; 6 | import org.springframework.beans.factory.annotation.Autowired; 7 | import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; 8 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; 9 | import org.springframework.boot.context.properties.EnableConfigurationProperties; 10 | import org.springframework.context.annotation.Bean; 11 | import org.springframework.context.annotation.Configuration; 12 | 13 | import com.corundumstudio.socketio.AuthorizationListener; 14 | import com.corundumstudio.socketio.SocketIOServer; 15 | import com.corundumstudio.socketio.annotation.SpringAnnotationScanner; 16 | import com.corundumstudio.socketio.handler.SuccessAuthorizationListener; 17 | import com.corundumstudio.socketio.listener.DefaultExceptionListener; 18 | import com.corundumstudio.socketio.listener.ExceptionListener; 19 | import com.corundumstudio.socketio.spring.boot.hooks.SocketioServerShutdownHook; 20 | import com.corundumstudio.socketio.store.MemoryStoreFactory; 21 | import com.corundumstudio.socketio.store.StoreFactory; 22 | 23 | import io.netty.channel.epoll.Epoll; 24 | 25 | @Configuration 26 | @ConditionalOnProperty(prefix = SocketioServerProperties.PREFIX, value = "enabled", havingValue = "true") 27 | @EnableConfigurationProperties({ SocketioServerProperties.class }) 28 | public class SocketioServerAutoConfiguration implements DisposableBean { 29 | 30 | protected static Logger LOG = LoggerFactory.getLogger(SocketioServerAutoConfiguration.class); 31 | 32 | @Bean 33 | @ConditionalOnMissingBean 34 | public AuthorizationListener socketAuthzListener() { 35 | return new SuccessAuthorizationListener(); 36 | } 37 | 38 | @Bean 39 | @ConditionalOnMissingBean 40 | public ExceptionListener exceptionListener() { 41 | return new DefaultExceptionListener(); 42 | } 43 | 44 | @Bean 45 | @ConditionalOnMissingBean 46 | public StoreFactory clientStoreFactory() { 47 | return new MemoryStoreFactory(); 48 | } 49 | 50 | @Bean(destroyMethod = "stop") 51 | public SocketIOServer socketIOServer( 52 | SocketioServerProperties config, 53 | AuthorizationListener socketAuthzListener, 54 | ExceptionListener exceptionListener, 55 | StoreFactory clientStoreFactory) { 56 | 57 | // 身份验证 58 | config.setAuthorizationListener(socketAuthzListener); 59 | config.setExceptionListener(exceptionListener); 60 | config.setStoreFactory(clientStoreFactory); 61 | 62 | if (config.isUseLinuxNativeEpoll() 63 | && !config.isFailIfNativeEpollLibNotPresent() 64 | && !Epoll.isAvailable()) { 65 | LOG.warn("Epoll library not available, disabling native epoll"); 66 | config.setUseLinuxNativeEpoll(false); 67 | } 68 | 69 | final SocketIOServer server = new SocketIOServer(config); 70 | 71 | /** 72 | * 应用退出时，要调用shutdown来清理资源，关闭网络连接，注销自己 73 | * 注意：我们建议应用在JBOSS、Tomcat等容器的退出钩子里调用shutdown方法 74 | */ 75 | Runtime.getRuntime().addShutdownHook(new SocketioServerShutdownHook(server)); 76 | 77 | server.start(); 78 | 79 | return server; 80 | } 81 | 82 | @Bean 83 | public SpringAnnotationScanner springAnnotationScanner(SocketIOServer socketServer) { 84 | return new SpringAnnotationScanner(socketServer); 85 | } 86 | 87 | @Autowired 88 | protected SocketIOServer socketIOServer; 89 | 90 | @Override 91 | public void destroy() throws Exception { 92 | if (socketIOServer != null) { 93 | socketIOServer.stop(); 94 | } 95 | } 96 | 97 | } 98 | -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/spring/boot/SocketioServerProperties.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010-2020, hiwepy (https://github.com/hiwepy). 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 | * use this file except in compliance with the License. You may obtain a copy of 6 | * the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | * License for the specific language governing permissions and limitations under 14 | * the License. 15 | */ 16 | package com.corundumstudio.socketio.spring.boot; 17 | 18 | import org.springframework.boot.context.properties.ConfigurationProperties; 19 | 20 | import com.corundumstudio.socketio.Configuration; 21 | 22 | @ConfigurationProperties(SocketioServerProperties.PREFIX) 23 | public class SocketioServerProperties extends Configuration { 24 | 25 | public static final String PREFIX = "socketio.server"; 26 | 27 | /** 28 | * If set to true, then useLinuxNativeEpoll property is passed to SocketIO server as is. 29 | * If set to false and useLinuxNativeEpoll set to true, 30 | * then additional check is performed if epoll library is available on classpath. 31 | */ 32 | private boolean failIfNativeEpollLibNotPresent = false; 33 | 34 | public boolean isFailIfNativeEpollLibNotPresent() { 35 | return failIfNativeEpollLibNotPresent; 36 | } 37 | 38 | public void setFailIfNativeEpollLibNotPresent(boolean failIfNativeEpollLibNotPresent) { 39 | this.failIfNativeEpollLibNotPresent = failIfNativeEpollLibNotPresent; 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/spring/boot/handler/AbstractSocketEventHandler.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2018, hiwepy (https://github.com/hiwepy). 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 | * use this file except in compliance with the License. You may obtain a copy of 6 | * the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | * License for the specific language governing permissions and limitations under 14 | * the License. 15 | */ 16 | package com.corundumstudio.socketio.spring.boot.handler; 17 | 18 | import java.util.Collection; 19 | 20 | import org.slf4j.Logger; 21 | import org.slf4j.LoggerFactory; 22 | 23 | import com.corundumstudio.socketio.SocketIOClient; 24 | import com.corundumstudio.socketio.SocketIOServer; 25 | import com.corundumstudio.socketio.annotation.OnConnect; 26 | import com.corundumstudio.socketio.annotation.OnDisconnect; 27 | 28 | public abstract class AbstractSocketEventHandler { 29 | 30 | private static Logger LOG = LoggerFactory.getLogger(AbstractSocketEventHandler.class); 31 | private SocketIOServer socketIOServer; 32 | 33 | public AbstractSocketEventHandler() { 34 | } 35 | 36 | public AbstractSocketEventHandler(SocketIOServer socketIOServer) { 37 | this.socketIOServer = socketIOServer; 38 | } 39 | 40 | // 添加connect事件，当客户端发起连接时调用，本文中将clientid与sessionid存入数据库 41 | // 方便后面发送消息时查找到对应的目标client, 42 | @OnConnect 43 | public void onConnect(SocketIOClient client) { 44 | LOG.debug("Connect OK."); 45 | LOG.debug("Session ID : %s", client.getSessionId()); 46 | LOG.debug("HttpHeaders : %s", client.getHandshakeData().getHttpHeaders()); 47 | LOG.debug("UrlParams : %s", client.getHandshakeData().getUrlParams()); 48 | 49 | client.sendEvent("welcome", "ok"); 50 | } 51 | 52 | // 添加@OnDisconnect事件，客户端断开连接时调用，刷新客户端信息 53 | @OnDisconnect 54 | public void onDisconnect(SocketIOClient client) { 55 | LOG.debug("Disconnect OK."); 56 | LOG.debug("Session ID : %s", client.getSessionId()); 57 | } 58 | 59 | public Collection getClients(String group) { 60 | return getSocketIOServer().getNamespace(group).getAllClients(); 61 | } 62 | 63 | public SocketIOServer getSocketIOServer() { 64 | return socketIOServer; 65 | } 66 | 67 | public void setSocketIOServer(SocketIOServer socketIOServer) { 68 | this.socketIOServer = socketIOServer; 69 | } 70 | 71 | } 72 | -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/spring/boot/hooks/SocketioServerShutdownHook.java: -------------------------------------------------------------------------------- 1 | package com.corundumstudio.socketio.spring.boot.hooks; 2 | 3 | import com.corundumstudio.socketio.SocketIOServer; 4 | 5 | public class SocketioServerShutdownHook extends Thread { 6 | 7 | private SocketIOServer server; 8 | 9 | public SocketioServerShutdownHook(SocketIOServer server) { 10 | this.server = server; 11 | } 12 | 13 | @Override 14 | public void run() { 15 | try { 16 | server.stop(); 17 | } catch (Exception e) { 18 | } 19 | } 20 | 21 | } 22 | -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/spring/boot/listener/JWTAuthorizationListener.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2018, hiwepy (https://github.com/hiwepy). 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 | * use this file except in compliance with the License. You may obtain a copy of 6 | * the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | * License for the specific language governing permissions and limitations under 14 | * the License. 15 | */ 16 | package com.corundumstudio.socketio.spring.boot.listener; 17 | 18 | import org.springframework.util.StringUtils; 19 | 20 | import com.corundumstudio.socketio.AuthorizationListener; 21 | import com.corundumstudio.socketio.HandshakeData; 22 | 23 | /** 24 | * TODO 25 | * @author ： wandl 26 | */ 27 | public class JWTAuthorizationListener implements AuthorizationListener { 28 | 29 | public static final String AUTHORIZATION_PARAM = "token"; 30 | /** 31 | * HTTP Authorization header, equal to Authorization 32 | */ 33 | public static final String AUTHORIZATION_HEADER = "X-Authorization"; 34 | 35 | private String authorizationHeaderName = AUTHORIZATION_HEADER; 36 | private String authorizationParamName = AUTHORIZATION_PARAM; 37 | 38 | @Override 39 | public boolean isAuthorized(HandshakeData data) { 40 | 41 | String token = obtainToken(data); 42 | 43 | if (token == null) { 44 | token = ""; 45 | } 46 | 47 | token = token.trim(); 48 | 49 | if(StringUtils.hasText(token)) { 50 | return true; 51 | } 52 | 53 | return false; 54 | } 55 | 56 | protected String obtainToken(HandshakeData data) { 57 | // 从header中获取token 58 | String token = data.getHttpHeaders().get(getAuthorizationHeaderName()); 59 | // 如果header中不存在token，则从参数中获取token 60 | if (StringUtils.isEmpty(token)) { 61 | return data.getSingleUrlParam(getAuthorizationParamName()); 62 | } 63 | return token; 64 | } 65 | 66 | public String getAuthorizationHeaderName() { 67 | return authorizationHeaderName; 68 | } 69 | 70 | public void setAuthorizationHeaderName(String authorizationHeaderName) { 71 | this.authorizationHeaderName = authorizationHeaderName; 72 | } 73 | 74 | public String getAuthorizationParamName() { 75 | return authorizationParamName; 76 | } 77 | 78 | public void setAuthorizationParamName(String authorizationParamName) { 79 | this.authorizationParamName = authorizationParamName; 80 | } 81 | 82 | } 83 | -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/store/RedisTemplateMap.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2018, hiwepy (https://github.com/hiwepy). 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 | * use this file except in compliance with the License. You may obtain a copy of 6 | * the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | * License for the specific language governing permissions and limitations under 14 | * the License. 15 | */ 16 | package com.corundumstudio.socketio.store; 17 | 18 | import java.util.Collection; 19 | import java.util.Map; 20 | import java.util.Set; 21 | import java.util.stream.Collectors; 22 | 23 | import org.springframework.data.redis.core.BoundHashOperations; 24 | import org.springframework.data.redis.core.RedisTemplate; 25 | 26 | /** 27 | * @author ： wandl 28 | */ 29 | @SuppressWarnings("unchecked") 30 | public class RedisTemplateMap implements Map { 31 | 32 | private final String name; 33 | private final BoundHashOperations hashOperations; 34 | 35 | public RedisTemplateMap(RedisTemplate redisTemplate, String name) { 36 | this.name = name; 37 | this.hashOperations = redisTemplate.boundHashOps(name); 38 | } 39 | 40 | @Override 41 | public int size() { 42 | return hashOperations.size().intValue(); 43 | } 44 | 45 | @Override 46 | public boolean isEmpty() { 47 | return size() > 0; 48 | } 49 | 50 | @Override 51 | public boolean containsKey(Object key) { 52 | return hashOperations.hasKey(key); 53 | } 54 | 55 | @Override 56 | public boolean containsValue(Object value) { 57 | return hashOperations.entries().containsValue(value); 58 | } 59 | 60 | @Override 61 | public V get(Object key) { 62 | return (V) hashOperations.get(key); 63 | } 64 | 65 | @Override 66 | public V put(Object key, Object value) { 67 | hashOperations.put(key, value); 68 | return (V) value; 69 | } 70 | 71 | @Override 72 | public V remove(Object key) { 73 | Object value = hashOperations.get(key); 74 | hashOperations.delete(name, key); 75 | return (V) value; 76 | } 77 | 78 | @Override 79 | public void putAll(Map m) { 80 | hashOperations.putAll(m); 81 | } 82 | 83 | @Override 84 | public void clear() { 85 | hashOperations.delete(name); 86 | } 87 | 88 | @Override 89 | public Set keySet() { 90 | return (Set) hashOperations.keys(); 91 | } 92 | 93 | @Override 94 | public Collection values() { 95 | return (Collection) hashOperations.values(); 96 | } 97 | 98 | @Override 99 | public Set> entrySet() { 100 | Set> sets = hashOperations.entries().entrySet(); 101 | if(sets != null) { 102 | return sets.stream().map((m) -> { 103 | return (Entry) m; 104 | }).collect(Collectors.toSet()); 105 | } 106 | return null; 107 | } 108 | 109 | } 110 | -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/store/RedisTemplatePubSubStore.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2018, hiwepy (https://github.com/hiwepy). 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 | * use this file except in compliance with the License. You may obtain a copy of 6 | * the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | * License for the specific language governing permissions and limitations under 14 | * the License. 15 | */ 16 | package com.corundumstudio.socketio.store; 17 | 18 | import java.util.Queue; 19 | import java.util.concurrent.ConcurrentLinkedQueue; 20 | import java.util.concurrent.ConcurrentMap; 21 | 22 | import org.springframework.data.redis.connection.Message; 23 | import org.springframework.data.redis.connection.MessageListener; 24 | import org.springframework.data.redis.core.RedisTemplate; 25 | import org.springframework.data.redis.listener.ChannelTopic; 26 | import org.springframework.data.redis.listener.RedisMessageListenerContainer; 27 | 28 | import com.corundumstudio.socketio.store.pubsub.PubSubListener; 29 | import com.corundumstudio.socketio.store.pubsub.PubSubMessage; 30 | import com.corundumstudio.socketio.store.pubsub.PubSubStore; 31 | import com.corundumstudio.socketio.store.pubsub.PubSubType; 32 | 33 | import io.netty.util.internal.PlatformDependent; 34 | 35 | public class RedisTemplatePubSubStore implements PubSubStore { 36 | 37 | private final RedisTemplate redisTemplate; 38 | private final RedisMessageListenerContainer listenerContainer; 39 | private final Long nodeId; 40 | 41 | private final ConcurrentMap> map = PlatformDependent.newConcurrentHashMap(); 42 | 43 | public RedisTemplatePubSubStore(RedisTemplate redisTemplate, RedisMessageListenerContainer listenerContainer, Long nodeId) { 44 | this.redisTemplate = redisTemplate; 45 | this.listenerContainer = listenerContainer; 46 | this.nodeId = nodeId; 47 | } 48 | 49 | @Override 50 | public void publish(PubSubType type, PubSubMessage msg) { 51 | msg.setNodeId(nodeId); 52 | redisTemplate.convertAndSend(type.toString(), msg); 53 | } 54 | 55 | @Override 56 | public void subscribe(PubSubType type, final PubSubListener listener, Class clazz) { 57 | String name = type.toString(); 58 | MessageListener msgListener = new MessageListener() { 59 | 60 | @SuppressWarnings("unchecked") 61 | @Override 62 | public void onMessage(Message message, byte[] pattern) { 63 | 64 | byte[] body = message.getBody(); 65 | PubSubMessage msg = (PubSubMessage) redisTemplate.getValueSerializer().deserialize(body); 66 | if (!nodeId.equals(msg.getNodeId())) { 67 | listener.onMessage((T) msg); 68 | } 69 | } 70 | 71 | }; 72 | listenerContainer.addMessageListener(msgListener, new ChannelTopic(name)); 73 | Queue list = map.get(name); 74 | if (list == null) { 75 | list = new ConcurrentLinkedQueue(); 76 | Queue oldList = map.putIfAbsent(name, list); 77 | if (oldList != null) { 78 | list = oldList; 79 | } 80 | } 81 | list.add(msgListener); 82 | } 83 | 84 | @Override 85 | public void unsubscribe(PubSubType type) { 86 | String name = type.toString(); 87 | Queue regListeners = map.remove(name); 88 | for (MessageListener listener : regListeners) { 89 | listenerContainer.removeMessageListener(listener); 90 | } 91 | } 92 | 93 | @Override 94 | public void shutdown() { 95 | } 96 | 97 | } 98 | -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/store/RedisTemplateStore.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2018, hiwepy (https://github.com/hiwepy). 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 | * use this file except in compliance with the License. You may obtain a copy of 6 | * the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | * License for the specific language governing permissions and limitations under 14 | * the License. 15 | */ 16 | package com.corundumstudio.socketio.store; 17 | 18 | import java.util.Map; 19 | import java.util.UUID; 20 | 21 | import org.springframework.data.redis.core.BoundHashOperations; 22 | import org.springframework.data.redis.core.RedisTemplate; 23 | 24 | @SuppressWarnings("unchecked") 25 | public class RedisTemplateStore implements Store { 26 | 27 | private final BoundHashOperations hashOperations; 28 | 29 | public RedisTemplateStore(UUID sessionId, RedisTemplate redisTemplate) { 30 | this.hashOperations = redisTemplate.boundHashOps(sessionId); 31 | } 32 | 33 | @Override 34 | public void set(String key, Object value) { 35 | hashOperations.put(key, value); 36 | } 37 | 38 | @Override 39 | public T get(String key) { 40 | Map map = hashOperations.entries(); 41 | if(map == null) { 42 | return null; 43 | } 44 | return (T) map.get(key); 45 | } 46 | 47 | @Override 48 | public boolean has(String key) { 49 | return hashOperations.hasKey(key); 50 | } 51 | 52 | @Override 53 | public void del(String key) { 54 | hashOperations.delete(key); 55 | } 56 | 57 | } -------------------------------------------------------------------------------- /src/main/java/com/corundumstudio/socketio/store/RedisTemplateStoreFactory.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2018, hiwepy (https://github.com/hiwepy). 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 | * use this file except in compliance with the License. You may obtain a copy of 6 | * the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | * License for the specific language governing permissions and limitations under 14 | * the License. 15 | */ 16 | package com.corundumstudio.socketio.store; 17 | 18 | import java.util.Map; 19 | import java.util.UUID; 20 | 21 | import org.springframework.data.redis.core.RedisTemplate; 22 | import org.springframework.data.redis.listener.RedisMessageListenerContainer; 23 | 24 | import com.corundumstudio.socketio.store.pubsub.BaseStoreFactory; 25 | import com.corundumstudio.socketio.store.pubsub.PubSubStore; 26 | 27 | public class RedisTemplateStoreFactory extends BaseStoreFactory { 28 | 29 | private final RedisTemplate redisTemplate; 30 | 31 | private final PubSubStore pubSubStore; 32 | 33 | public RedisTemplateStoreFactory(RedisTemplate redisTemplate, RedisMessageListenerContainer listenerContainer) { 34 | this.redisTemplate = redisTemplate; 35 | this.pubSubStore = new RedisTemplatePubSubStore(redisTemplate, listenerContainer, getNodeId()); 36 | } 37 | 38 | @Override 39 | public Store createStore(UUID sessionId) { 40 | return new RedisTemplateStore(sessionId, redisTemplate); 41 | } 42 | 43 | @Override 44 | public PubSubStore pubSubStore() { 45 | return pubSubStore; 46 | } 47 | 48 | @Override 49 | public void shutdown() { 50 | 51 | } 52 | 53 | @Override 54 | public Map createMap(String name) { 55 | return new RedisTemplateMap(redisTemplate, name); 56 | } 57 | 58 | } 59 | -------------------------------------------------------------------------------- /src/main/java/org/redisson/config/RedissonConfig.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2018, hiwepy (https://github.com/hiwepy). 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 | * use this file except in compliance with the License. You may obtain a copy of 6 | * the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | * License for the specific language governing permissions and limitations under 14 | * the License. 15 | */ 16 | package org.redisson.config; 17 | 18 | /** 19 | * TODO 20 | * 21 | * @author ： wandl 22 | */ 23 | 24 | public class RedissonConfig extends Config { 25 | 26 | public RedissonConfig() { 27 | super(); 28 | } 29 | 30 | public RedissonConfig(Config oldConf) { 31 | super(oldConf); 32 | } 33 | 34 | public RedissonConfig(ClusterServersConfig clusterServersConfig) { 35 | super(); 36 | useClusterServers(clusterServersConfig); 37 | } 38 | 39 | public RedissonConfig(MasterSlaveServersConfig masterSlaveServersConfig) { 40 | super(); 41 | useMasterSlaveServers(masterSlaveServersConfig); 42 | } 43 | 44 | public RedissonConfig(ReplicatedServersConfig replicatedServersConfig) { 45 | super(); 46 | useReplicatedServers(replicatedServersConfig); 47 | } 48 | 49 | public RedissonConfig(SentinelServersConfig sentinelServersConfig) { 50 | super(); 51 | useSentinelServers(sentinelServersConfig); 52 | } 53 | 54 | public RedissonConfig(SingleServerConfig singleServerConfig) { 55 | super(); 56 | useSingleServer(singleServerConfig); 57 | } 58 | 59 | public RedissonConfig(ClusterServersConfig clusterServersConfig, 60 | MasterSlaveServersConfig masterSlaveServersConfig, 61 | ReplicatedServersConfig replicatedServersConfig, 62 | SentinelServersConfig sentinelServersConfig, 63 | SingleServerConfig singleServerConfig) { 64 | super(); 65 | setClusterServersConfig(clusterServersConfig); 66 | setMasterSlaveServersConfig(masterSlaveServersConfig); 67 | setReplicatedServersConfig(replicatedServersConfig); 68 | setSentinelServersConfig(sentinelServersConfig); 69 | setSingleServerConfig(singleServerConfig); 70 | } 71 | 72 | 73 | } 74 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/spring-autoconfigure-metadata.properties: -------------------------------------------------------------------------------- 1 | com.corundumstudio.socketio.spring.boot.SocketioRedissonConfiguration= 2 | com.corundumstudio.socketio.spring.boot.SocketioRedisTemplateConfiguration= 3 | com.corundumstudio.socketio.spring.boot.SocketioServerAutoConfiguration= 4 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/spring.factories: -------------------------------------------------------------------------------- 1 | # Auto Configure 2 | org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ 3 | com.corundumstudio.socketio.spring.boot.SocketioRedissonConfiguration,\ 4 | com.corundumstudio.socketio.spring.boot.SocketioRedisTemplateConfiguration,\ 5 | com.corundumstudio.socketio.spring.boot.SocketioServerAutoConfiguration 6 | -------------------------------------------------------------------------------- /src/test/resources/application.yml: -------------------------------------------------------------------------------- 1 | ################################################################################################# ### SocketIO 配置： ################################################################################################# socketio: redis: redisson: enabled: true server: single single: address: redis://192.168.2.237:6379 password: redis client-name: redis connection-minimum-idle-size: 5 connection-pool-size: 50 template: enabled: false # 服务端配置 server: enabled: true ## host在本地测试可以设置为localhost或者本机IP，在Linux服务器跑可换成服务器IP hostname: 192.168.2.222 ## netty启动端口 port: 10065 ## 添加头部版本信息 add-version-header: true ## Ping消息间隔（毫秒），默认25秒。客户端向服务器发送一条心跳消息间隔 ping-interval: 25000 ## Ping消息超时时间（毫秒），默认60秒，这个时间间隔内没有接收到心跳消息就会发送超时事件 ping-timeout: 60000 ## 设置最大每帧处理数据的长度，防止他人利用大数据来攻击服务器 max-frame-payload-length: 1048576 ## 设置http交互最大内容长度 max-http-content-length: 1048576 ## socket连接数大小（如只监听一个端口boss线程组为1即可） boss-threads: 1 transports: - polling - websocket worker-threads: 100 ## 协议升级超时时间（毫秒），默认10秒。HTTP握手升级为ws协议超时时间 upgrade-timeout: 15000 ## socket配置 socket-config: reuse-address: true tcp-no-delay: true so-linger: 0 ack-mode: auto allow-custom-requests: true ## sessionID 通过请求头io来获取 random-session: false -------------------------------------------------------------------------------- /src/test/resources/log4j.properties: -------------------------------------------------------------------------------- 1 | 2 | # This is the configuring for logging displayed in the Application Server 3 | log4j.rootCategory= INFO, stdout, R 4 | 5 | # Replace the line above if you want to put a log file into the directory 6 | # you start Tomcat from 7 | # log4j.rootCategory=INFO, stdout, R 8 | 9 | log4j.appender.stdout=org.apache.log4j.ConsoleAppender 10 | log4j.appender.stdout.Target=System.out 11 | log4j.appender.stdout.layout=org.apache.log4j.PatternLayout 12 | 13 | # Pattern to output the caller's file name and line number. 14 | log4j.appender.stdout.layout.ConversionPattern=[%p] %d{yyyy-MM-dd HH:mm:ss.SSS} [%F:%L]%m%n 15 | 16 | #%m 输出代码中指定的消息 17 | #%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL 18 | #%r 输出自应用启动到输出该log信息耗费的毫秒数 19 | #%c 输出所属的类目，通常就是所在类的全名 20 | #%t 输出产生该日志事件的线程名 21 | #%n 输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n” 22 | #%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss , SSS}，输出类似：2002年10月18日 22 ： 10 ： 28 ， 921 23 | #%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java: 10 ) 24 | 25 | 26 | log4j.logger.com.hazelcast=debug 27 | #log4j.logger.com.hazelcast.cluster=debug 28 | #log4j.logger.com.hazelcast.partition=debug 29 | #log4j.logger.com.hazelcast.partition.InternalPartitionService=debug 30 | #log4j.logger.com.hazelcast.nio=debug 31 | #log4j.logger.com.hazelcast.hibernate=debug 32 | 33 | 34 | # ========================//TODO 这一段配置暂时没有用 start================================================================ 35 | log4j.appender.R=org.apache.log4j.DailyRollingFileAppender 36 | # You can change this to be an absolute path or even an environment variable 37 | # If you're using an environment variable, you will have to set JAVA_OPTS 38 | # to contain this variables - for example in the catalina.sh or catalina.bat 39 | # file 40 | log4j.appender.R.File=${catalina.home}/logs/zftal_jwglxt.log 41 | #log4j.appender.R.maxFileSize=1000KB 42 | # Don't keep a backup file 43 | #log4j.appender.R.maxBackupIndex=10 44 | log4j.appender.R.layout=org.apache.log4j.PatternLayout 45 | log4j.appender.R.layout.ConversionPattern=%t %d{dd/MM HH:mm:ss,SSS} %p [%20.30c{2}]-%L %m%n 46 | 47 | # ========================//TODO 这一段配置暂时没有用 end ================================================================ 48 | log4j.logger.com.eucita=DEBUG 49 | log4j.logger.com.eucita.component.acegi=WARN 50 | log4j.logger.com.eucita.utils.GenericsUtils=ERROR 51 | 52 | # If programmed properly the most messages would be at DEBUG 53 | # and the least at FATAL. 54 | 55 | # Control logging for other open source packages 56 | #log4j.logger.org.apache.commons=ERROR 57 | 58 | log4j.logger.org.apache=WARN 59 | log4j.logger.org.hibernate=WARN 60 | log4j.logger.org.springframework=WARN 61 | log4j.logger.com.opensymphony=WARN 62 | log4j.logger.org.springmodules=WARN 63 | log4j.logger.org.jbpm=WARN 64 | 65 | #log4j.logger.com.opensymphony.webwork=DEBUG 66 | log4j.logger.java.sql.Connection=DEBUG 67 | log4j.logger.java.sql.Statement=DEBUG 68 | log4j.logger.java.sql.PreparedStatement=DEBUG 69 | #log4j.logger.java.sql.ResultSet=DEBUG 70 | log4j.logger.com.ibatis=DEBUG 71 | log4j.logger.com.ibatis.common.jdbc.SimpleDataSource=DEBUG 72 | log4j.logger.com.ibatis.common.jdbc.ScriptRunner=DEBUG 73 | log4j.logger.com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate=DEBUG 74 | 75 | log4j.logger.org.hibernate.type.descriptor.sql.BasicBinder=TRACE 76 | log4j.logger.org.hibernate.type.descriptor.sql.BasicExtractor=DEBUG 77 | log4j.logger.org.hibernate.SQL=DEBUG 78 | log4j.logger.org.hibernate.engine.QueryParameters=DEBUG 79 | log4j.logger.org.hibernate.engine.query.HQLQueryPlan=DEBUG 80 | log4j.logger.org.hibernate.util.DTDEntityResolver=OFF 81 | --------------------------------------------------------------------------------