├── .gitignore ├── LICENSE ├── README.md ├── doc └── README_ZH.md ├── pom.xml └── src └── main └── java └── com └── github └── caryyu └── spring └── embedded └── redisserver └── RedisServerConfiguration.java /.gitignore: -------------------------------------------------------------------------------- 1 | HELP.md 2 | target/ 3 | !.mvn/wrapper/maven-wrapper.jar 4 | !**/src/main/** 5 | !**/src/test/** 6 | 7 | ### STS ### 8 | .apt_generated 9 | .classpath 10 | .factorypath 11 | .project 12 | .settings 13 | .springBeans 14 | .sts4-cache 15 | 16 | ### IntelliJ IDEA ### 17 | .idea 18 | *.iws 19 | *.iml 20 | *.ipr 21 | 22 | ### NetBeans ### 23 | /nbproject/private/ 24 | /nbbuild/ 25 | /dist/ 26 | /nbdist/ 27 | /.nb-gradle/ 28 | build/ 29 | 30 | ### VS Code ### 31 | .vscode/ -------------------------------------------------------------------------------- /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 | # spring-embedded-redis-server 2 | A tiny redis embedded server fully integrated with Spring and Spring Boot, Only for testing or debugging. 3 | 4 | ## version required 5 | * Spring 3.1 + 6 | * JDK 1.6 + 7 | 8 | ## local installation 9 | > Note: this step is optional, Can be able to fetch the dependencies directly from Central. 10 | ``` 11 | git clone https://github.com/caryyu/spring-embedded-redis-server 12 | mvn install 13 | ``` 14 | 15 | ## maven dependencies 16 | ``` 17 | 18 | com.github.caryyu 19 | spring-embedded-redis-server 20 | 1.0 21 | 22 | ``` 23 | 24 | ## spring configuration 25 | We can pass the configuration as the following 26 | > Note: we just only need to choose one of following three ones to pass. 27 | ### component scan 28 | the package of `com.github.caryyu` is must. 29 | ``` 30 | 31 | ``` 32 | ### modify `spring-context.xml` file 33 | the xml filename based on your real situation. 34 | ``` 35 | 36 | ``` 37 | ### spring boot annotation 38 | ``` 39 | @Bean 40 | public RedisServerConfiguration redisServerConfiguration(){ 41 | return new RedisServerConfiguration(); 42 | } 43 | ``` 44 | ## usage 45 | Here's two core variables to use. 46 | * global.redis.port - this is the embedded port for server listening. 47 | * global.redis.embedded - this is the switch to check whether or not it is ON/OFF. 48 | 49 | Actually , we have lots of ways to use this library, ofcourse i really recommend you according to [Spring official Environment Variables](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html),so i just give some usages below. 50 | 51 | ### jvm environment variables 52 | 53 | #### using for JavaSE 54 | ``` 55 | java -Dspring.redis.embedded=true 56 | ``` 57 | 58 | #### using under Tomcat 59 | we need to modify catalina.sh or catalina.bat or add new file that can name `setenv.sh` etc. 60 | ``` 61 | set JAVA_OPTS="-Dspring.redis.embedded=true" 62 | ``` 63 | 64 | ### application.properties 65 | ``` 66 | spring.redis.port=6379 67 | spring.redis.embedded=true 68 | ``` 69 | ### application.yml 70 | ``` 71 | spring: 72 | redis: 73 | port: 6379 74 | embedded: true 75 | ``` 76 | ## Contribution 77 | All Contributions are welcomed. 78 | 79 | 80 | -------------------------------------------------------------------------------- /doc/README_ZH.md: -------------------------------------------------------------------------------- 1 | # spring-embedded-redis-server 2 | 依赖 Spring 容器的 Redis 内嵌小型服务器，仅做调试或测试时使用。a Redis embedded server based on Spring, Only for testing or debugging. 3 | 4 | ## 版本需求 / Version Required 5 | * Spring 3.1 + 6 | * JDK 1.6 + 7 | 8 | ## 本地安装 / Local Installation 9 | > 注意：这一步是可选的，可以直接从中央仓库获取依赖；Notice: this step is optional, Can be able to fetch the dependencies directly from Central. 10 | ``` 11 | git clone https://github.com/caryyu/spring-embedded-redis-server 12 | mvn install 13 | ``` 14 | ## 依赖配置 / Maven Dependencies 15 | 注意：依赖包需要先进行以上本地方式安装方可找到。 16 | ``` 17 | 18 | com.github.caryyu 19 | spring-embedded-redis-server 20 | 1.0 21 | 22 | 23 | 24 | com.github.kstyrc 25 | embedded-redis 26 | 0.6 27 | runtime 28 | 29 | ``` 30 | 31 | ## Spring 核心配置 / Spring Configuration 32 | 我们有三种方式可以配置应用. We have 3 ways to configure this. 33 | ### 方式一 / Way 1 34 | 直接配置此项目的包名前缀进行自动扫描。 35 | ``` 36 | 37 | ``` 38 | ### 方式二 / Way 2 39 | 配置 XML 文件。 40 | ``` 41 | 42 | ``` 43 | ### 方式二 / Way 3 44 | Spring Boot 注解配置 45 | ``` 46 | @Bean 47 | public RedisServerConfiguration redisServerConfiguration(){ 48 | return new RedisServerConfiguration(); 49 | } 50 | ``` 51 | ## 使用方式 / Usage 52 | * global.redis.port - 设置内嵌服务端口号. this is the embedded port for server listening. 53 | * global.redis.embedded - 设置内嵌服务是否开启,true表示开启,false表示关闭. this is the switch to check whether or not it is ON/OFF. 54 | ### JVM 环境变量 / JVM Environment Variables 55 | 使用VM属性进行设置开启内嵌服务. We can pass this by JVM environment variables. 56 | 57 | 简单的 Java 程序. Simple java program 58 | ``` 59 | java -Dglobal.redis.embedded=true 60 | ``` 61 | 62 | 在 Tomcat 中的 catalina.sh 或 catalina.bat 中设置. On Tomcat under catalina.sh or catalina.bat 63 | ``` 64 | set JAVA_OPTS="-Dglobal.redis.embedded=true" 65 | ``` 66 | 67 | e.g.(-Dglobal.redis.embedded=true）。 68 | ### 设置 application.properties / Setting application.properties 69 | ``` 70 | global.redis.port=6379 71 | global.redis.embedded=true 72 | ``` 73 | ### 设置 application.yml / Setting application.tml 74 | ``` 75 | global: 76 | redis: 77 | port: 6379 78 | embedded: true 79 | ``` 80 | ## 贡献 / Contribution 81 | 欢迎提交 PR 来进行改进。 All PRs are welcomed. 82 | 83 | 84 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | com.github.caryyu 8 | spring-embedded-redis-server 9 | 1.1 10 | jar 11 | spring-embedded-redis-server 12 | A tiny redis embedded server fully integrated with Spring and Spring Boot, Only for testing or debugging. 13 | https://github.com/caryyu/spring-embedded-redis-server 14 | 15 | 16 | 17 | The Apache Software License, Version 2.0 18 | http://www.apache.org/licenses/LICENSE-2.0.txt 19 | repo 20 | 21 | 22 | 23 | 24 | https://github.com/caryyu/spring-embedded-redis-server 25 | scm:git:https://github.com/caryyu/spring-embedded-redis-server.git 26 | scm:git:https://github.com/caryyu/spring-embedded-redis-server.git 27 | spring-embedded-redis-server-1.0 28 | 29 | 30 | 31 | 32 | caryyu 33 | 343194291@qq.com 34 | 35 | 36 | 37 | 38 | 1.6 39 | UTF-8 40 | 41 | 42 | 43 | 44 | oss 45 | https://oss.sonatype.org/content/repositories/snapshots 46 | 47 | 48 | oss 49 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 50 | 51 | 52 | 53 | 54 | 55 | org.springframework 56 | spring-context 57 | 3.1.0.RELEASE 58 | 59 | 60 | com.github.kstyrc 61 | embedded-redis 62 | 0.6 63 | 64 | 65 | 66 | 67 | 68 | 69 | org.apache.maven.plugins 70 | maven-compiler-plugin 71 | 2.5.1 72 | 73 | ${java.version} 74 | ${java.version} 75 | ${project.build.sourceEncoding} 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | release 84 | 85 | 86 | 87 | 88 | org.apache.maven.plugins 89 | maven-source-plugin 90 | 2.1.2 91 | 92 | 93 | attach-sources 94 | 95 | jar 96 | 97 | 98 | 99 | 100 | 101 | 102 | org.apache.maven.plugins 103 | maven-javadoc-plugin 104 | 2.8.1 105 | 106 | 107 | attach-javadocs 108 | 109 | jar 110 | 111 | 112 | 113 | 114 | 115 | 116 | org.apache.maven.plugins 117 | maven-gpg-plugin 118 | 1.5 119 | 120 | 121 | sign-artifacts 122 | verify 123 | 124 | sign 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | -------------------------------------------------------------------------------- /src/main/java/com/github/caryyu/spring/embedded/redisserver/RedisServerConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.github.caryyu.spring.embedded.redisserver; 2 | 3 | import org.apache.commons.logging.Log; 4 | import org.apache.commons.logging.LogFactory; 5 | import org.springframework.beans.FatalBeanException; 6 | import org.springframework.beans.factory.DisposableBean; 7 | import org.springframework.beans.factory.InitializingBean; 8 | import org.springframework.context.EnvironmentAware; 9 | import org.springframework.context.annotation.Configuration; 10 | import org.springframework.core.env.Environment; 11 | import org.springframework.stereotype.Component; 12 | import redis.embedded.RedisServer; 13 | 14 | import java.io.IOException; 15 | 16 | /** 17 | * 核心配置信息,一定要让Spring进行扫描到才可以生效, 18 | * 主要通过系统环境属性进行控制. 19 | * 20 | * @author cary 21 | * @since Spring 3.1 22 | */ 23 | @Component 24 | public class RedisServerConfiguration implements DisposableBean, EnvironmentAware, InitializingBean { 25 | private Log log = LogFactory.getLog(this.getClass()); 26 | private RedisServer redisServer; 27 | private Environment environment; 28 | 29 | /** 30 | * 通过环境属性(global.redis.port)进行控制 31 | * @return 端口号 32 | */ 33 | public int getPort() { 34 | int v = environment.getProperty("spring.redis.port",Integer.class,0); 35 | v = v == 0 ? environment.getProperty("global.redis.port",Integer.class,6379) : v; 36 | return v; 37 | } 38 | 39 | /** 40 | * 通过环境属性(global.redis.embedded)进行控制 41 | * @return TRUE/FALSE 42 | */ 43 | private boolean isEmbedded() { 44 | Boolean v = environment.getProperty("spring.redis.embedded",Boolean.class,null); 45 | v = v == null ? environment.getProperty("global.redis.embedded",Boolean.class,false) : v; 46 | return v; 47 | } 48 | 49 | @Override 50 | public void destroy() throws Exception { 51 | if(redisServer != null) { 52 | redisServer.stop(); 53 | redisServer = null; 54 | } 55 | } 56 | 57 | @Override 58 | public void afterPropertiesSet() throws Exception { 59 | // 如果Redis嵌入式服务器配置是关闭的则直接跳出 60 | if (!isEmbedded()) { 61 | return; 62 | } 63 | 64 | try { 65 | int port = getPort(); 66 | redisServer = new RedisServer(port); 67 | redisServer.start(); 68 | 69 | if(log.isInfoEnabled()) { 70 | log.info("Starting local embedded redis server successfully, port is " + port); 71 | } 72 | } catch (IOException e) { 73 | throw new FatalBeanException("Failed to start local embedded redis server ", e); 74 | } 75 | } 76 | 77 | @Override 78 | public void setEnvironment(Environment environment) { 79 | this.environment = environment; 80 | } 81 | } 82 | --------------------------------------------------------------------------------