├── .gitattributes ├── .github └── workflows │ ├── ci.yaml │ ├── codeql.yaml │ ├── coveralls.yaml │ ├── site.yaml │ ├── sonar.yaml │ └── sonatype.yaml ├── .gitignore ├── .mvn ├── extensions.xml ├── maven.config ├── settings.xml └── wrapper │ ├── MavenWrapperDownloader.java │ └── maven-wrapper.properties ├── LICENSE ├── LICENSE_HEADER ├── NOTICE ├── README.md ├── format.xml ├── mvnw ├── mvnw.cmd ├── pom.xml ├── renovate.json └── src ├── main └── java │ └── org │ └── mybatis │ └── caches │ └── redis │ ├── DummyReadWriteLock.java │ ├── JDKSerializer.java │ ├── KryoSerializer.java │ ├── RedisCache.java │ ├── RedisCallback.java │ ├── RedisConfig.java │ ├── RedisConfigurationBuilder.java │ ├── Serializer.java │ └── package-info.java ├── site ├── site.xml └── xdoc │ └── index.xml.vm └── test ├── java └── org │ └── mybatis │ └── caches │ └── redis │ ├── RedisConfigurationBuilderTest.java │ ├── RedisTestCase.java │ ├── SerializerTestCase.java │ ├── SimpleBeanCourseInfo.java │ ├── SimpleBeanStudentInfo.java │ └── sslconfig │ ├── TestHostnameVerifier.java │ ├── TestSSLParameters.java │ └── TestSSLSocketFactory.java └── resources ├── redis.properties ├── simpleBeanCourseInfoSerializedFile └── test1.properties /.gitattributes: -------------------------------------------------------------------------------- 1 | # Set default behaviour, in case users don't have core.autocrlf set. 2 | * text=auto 3 | -------------------------------------------------------------------------------- /.github/workflows/ci.yaml: -------------------------------------------------------------------------------- 1 | name: Java CI 2 | 3 | on: [workflow_dispatch, push, pull_request] 4 | 5 | permissions: read-all 6 | 7 | jobs: 8 | test: 9 | runs-on: ${{ matrix.os }} 10 | strategy: 11 | matrix: 12 | cache: [maven] 13 | distribution: [temurin] 14 | java: [17, 21, 24, 25-ea] 15 | os: [macos-latest, ubuntu-latest] 16 | fail-fast: false 17 | max-parallel: 4 18 | name: Test JDK ${{ matrix.java }}, ${{ matrix.os }} 19 | 20 | steps: 21 | - uses: actions/checkout@v4 22 | - name: Setup Java ${{ matrix.java }} ${{ matrix.distribution }} 23 | uses: actions/setup-java@v4 24 | with: 25 | cache: ${{ matrix.cache }} 26 | distribution: ${{ matrix.distribution }} 27 | java-version: ${{ matrix.java }} 28 | - name: Start Redis 29 | uses: shogo82148/actions-setup-redis@v1.41.0 30 | with: 31 | redis-version: latest 32 | - name: Test with Maven 33 | run: ./mvnw test -B -V --no-transfer-progress -D"license.skip=true" 34 | -------------------------------------------------------------------------------- /.github/workflows/codeql.yaml: -------------------------------------------------------------------------------- 1 | name: "CodeQL" 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | schedule: 9 | - cron: '43 10 * * 2' 10 | 11 | jobs: 12 | analyze: 13 | name: Analyze 14 | runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} 15 | timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }} 16 | permissions: 17 | actions: read 18 | contents: read 19 | security-events: write 20 | 21 | strategy: 22 | fail-fast: false 23 | matrix: 24 | language: [ java, kotlin ] 25 | 26 | steps: 27 | - name: Checkout 28 | uses: actions/checkout@v4 29 | 30 | - name: Setup Java 31 | uses: actions/setup-java@v4 32 | with: 33 | cache: maven 34 | distribution: 'temurin' 35 | java-version: 21 36 | 37 | - name: Initialize CodeQL 38 | uses: github/codeql-action/init@v3 39 | with: 40 | languages: ${{ matrix.language }} 41 | queries: +security-and-quality 42 | 43 | - name: Autobuild 44 | uses: github/codeql-action/autobuild@v3 45 | 46 | - name: Perform CodeQL Analysis 47 | uses: github/codeql-action/analyze@v3 48 | with: 49 | category: "/language:${{ matrix.language }}" 50 | -------------------------------------------------------------------------------- /.github/workflows/coveralls.yaml: -------------------------------------------------------------------------------- 1 | name: Coveralls 2 | 3 | on: [push, pull_request] 4 | 5 | permissions: read-all 6 | 7 | jobs: 8 | coveralls: 9 | if: github.repository_owner == 'mybatis' 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v4 13 | - name: Setup Java 14 | uses: actions/setup-java@v4 15 | with: 16 | cache: maven 17 | distribution: temurin 18 | java-version: 21 19 | - name: Start Redis 20 | uses: shogo82148/actions-setup-redis@v1.41.0 21 | with: 22 | redis-version: latest 23 | - name: Report Coverage to Coveralls for Pull Requests 24 | if: github.event_name == 'pull_request' 25 | run: ./mvnw -B -V test jacoco:report coveralls:report -q -Dlicense.skip=true -DrepoToken=$GITHUB_TOKEN -DserviceName=github -DpullRequest=$PR_NUMBER --no-transfer-progress 26 | env: 27 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 28 | PR_NUMBER: ${{ github.event.number }} 29 | - name: Report Coverage to Coveralls for General Push 30 | if: github.event_name == 'push' 31 | run: ./mvnw -B -V test jacoco:report coveralls:report -q -Dlicense.skip=true -DrepoToken=$GITHUB_TOKEN -DserviceName=github --no-transfer-progress 32 | env: 33 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 34 | -------------------------------------------------------------------------------- /.github/workflows/site.yaml: -------------------------------------------------------------------------------- 1 | name: Site 2 | 3 | on: 4 | push: 5 | branches: 6 | - site 7 | 8 | permissions: 9 | contents: write 10 | 11 | jobs: 12 | build: 13 | if: github.repository_owner == 'mybatis' && ! contains(toJSON(github.event.head_commit.message), '[maven-release-plugin]') 14 | runs-on: ubuntu-latest 15 | steps: 16 | - uses: actions/checkout@v4 17 | - name: Setup Java 18 | uses: actions/setup-java@v4 19 | with: 20 | cache: maven 21 | distribution: temurin 22 | java-version: 21 23 | - name: Build site 24 | run: ./mvnw site site:stage -DskipTests -Dlicense.skip=true -B -V --no-transfer-progress --settings ./.mvn/settings.xml 25 | env: 26 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 27 | NVD_API_KEY: ${{ secrets.NVD_API_KEY }} 28 | - name: Deploy Site to gh-pages 29 | uses: JamesIves/github-pages-deploy-action@v4 30 | with: 31 | branch: gh-pages 32 | folder: target/staging 33 | -------------------------------------------------------------------------------- /.github/workflows/sonar.yaml: -------------------------------------------------------------------------------- 1 | name: SonarCloud 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | 8 | permissions: read-all 9 | 10 | jobs: 11 | build: 12 | if: github.repository_owner == 'mybatis' 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v4 16 | with: 17 | # Disabling shallow clone is recommended for improving relevancy of reporting 18 | fetch-depth: 0 19 | - name: Setup Java 20 | uses: actions/setup-java@v4 21 | with: 22 | cache: maven 23 | distribution: temurin 24 | java-version: 21 25 | - name: Start Redis 26 | uses: shogo82148/actions-setup-redis@v1.41.0 27 | with: 28 | redis-version: latest 29 | - name: Analyze with SonarCloud 30 | run: ./mvnw verify jacoco:report sonar:sonar -B -V -Dsonar.projectKey=mybatis_redis-cache -Dsonar.organization=mybatis -Dsonar.host.url=https://sonarcloud.io -Dsonar.token=$SONAR_TOKEN -Dlicense.skip=true --no-transfer-progress -Dsonar.scanner.skipJreProvisioning=true 31 | env: 32 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 33 | SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} 34 | -------------------------------------------------------------------------------- /.github/workflows/sonatype.yaml: -------------------------------------------------------------------------------- 1 | name: Sonatype 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | 8 | permissions: read-all 9 | 10 | jobs: 11 | build: 12 | if: github.repository_owner == 'mybatis' && ! contains(toJSON(github.event.head_commit.message), '[maven-release-plugin]') 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v4 16 | - name: Setup Java 17 | uses: actions/setup-java@v4 18 | with: 19 | cache: maven 20 | distribution: temurin 21 | java-version: 21 22 | - name: Start Redis 23 | uses: shogo82148/actions-setup-redis@v1.41.0 24 | with: 25 | redis-version: latest 26 | - name: Deploy to Sonatype 27 | run: ./mvnw deploy -DskipTests -B -V --no-transfer-progress --settings ./.mvn/settings.xml -Dlicense.skip=true 28 | env: 29 | CI_DEPLOY_USERNAME: ${{ secrets.CI_DEPLOY_USERNAME }} 30 | CI_DEPLOY_PASSWORD: ${{ secrets.CI_DEPLOY_PASSWORD }} 31 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /*.iml 2 | /*.ipr 3 | /*.iws 4 | /.classpath 5 | /.idea 6 | /.project 7 | /.settings 8 | /ibderby 9 | /nb* 10 | /release.properties 11 | /target 12 | /test.db.lck 13 | /test.db.log 14 | /test.db.properties 15 | /test.db.script 16 | /test.db.tmp 17 | /src/docbkx 18 | velocity.log 19 | /bin 20 | .mvn/wrapper/maven-wrapper.jar 21 | *.releaseBackup 22 | -------------------------------------------------------------------------------- /.mvn/extensions.xml: -------------------------------------------------------------------------------- 1 | 2 | 19 | 20 | 21 | fr.jcgay.maven 22 | maven-profiler 23 | 3.3 24 | 25 | 26 | -------------------------------------------------------------------------------- /.mvn/maven.config: -------------------------------------------------------------------------------- 1 | -Daether.checksums.algorithms=SHA-512,SHA-256,SHA-1,MD5 2 | -Daether.connector.smartChecksums=false 3 | -------------------------------------------------------------------------------- /.mvn/settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 19 | 21 | 22 | 23 | 24 | 25 | central 26 | ${env.CI_DEPLOY_USERNAME} 27 | ${env.CI_DEPLOY_PASSWORD} 28 | 29 | 30 | 31 | 32 | gh-pages-scm 33 | 34 | branch 35 | gh-pages 36 | 37 | 38 | 39 | 40 | 41 | github 42 | ${env.GITHUB_TOKEN} 43 | 44 | 45 | 46 | 47 | nvd 48 | ${env.NVD_API_KEY} 49 | 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /.mvn/wrapper/MavenWrapperDownloader.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * https://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | import java.io.IOException; 21 | import java.io.InputStream; 22 | import java.net.Authenticator; 23 | import java.net.PasswordAuthentication; 24 | import java.net.URI; 25 | import java.net.URL; 26 | import java.nio.file.Files; 27 | import java.nio.file.Path; 28 | import java.nio.file.StandardCopyOption; 29 | import java.util.concurrent.ThreadLocalRandom; 30 | 31 | public final class MavenWrapperDownloader { 32 | private static final String WRAPPER_VERSION = "3.3.2"; 33 | 34 | private static final boolean VERBOSE = Boolean.parseBoolean(System.getenv("MVNW_VERBOSE")); 35 | 36 | public static void main(String[] args) { 37 | log("Apache Maven Wrapper Downloader " + WRAPPER_VERSION); 38 | 39 | if (args.length != 2) { 40 | System.err.println(" - ERROR wrapperUrl or wrapperJarPath parameter missing"); 41 | System.exit(1); 42 | } 43 | 44 | try { 45 | log(" - Downloader started"); 46 | final URL wrapperUrl = URI.create(args[0]).toURL(); 47 | final String jarPath = args[1].replace("..", ""); // Sanitize path 48 | final Path wrapperJarPath = Path.of(jarPath).toAbsolutePath().normalize(); 49 | downloadFileFromURL(wrapperUrl, wrapperJarPath); 50 | log("Done"); 51 | } catch (IOException e) { 52 | System.err.println("- Error downloading: " + e.getMessage()); 53 | if (VERBOSE) { 54 | e.printStackTrace(); 55 | } 56 | System.exit(1); 57 | } 58 | } 59 | 60 | private static void downloadFileFromURL(URL wrapperUrl, Path wrapperJarPath) 61 | throws IOException { 62 | log(" - Downloading to: " + wrapperJarPath); 63 | if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) { 64 | final String username = System.getenv("MVNW_USERNAME"); 65 | final char[] password = System.getenv("MVNW_PASSWORD").toCharArray(); 66 | Authenticator.setDefault(new Authenticator() { 67 | @Override 68 | protected PasswordAuthentication getPasswordAuthentication() { 69 | return new PasswordAuthentication(username, password); 70 | } 71 | }); 72 | } 73 | Path temp = wrapperJarPath 74 | .getParent() 75 | .resolve(wrapperJarPath.getFileName() + "." 76 | + Long.toUnsignedString(ThreadLocalRandom.current().nextLong()) + ".tmp"); 77 | try (InputStream inStream = wrapperUrl.openStream()) { 78 | Files.copy(inStream, temp, StandardCopyOption.REPLACE_EXISTING); 79 | Files.move(temp, wrapperJarPath, StandardCopyOption.REPLACE_EXISTING); 80 | } finally { 81 | Files.deleteIfExists(temp); 82 | } 83 | log(" - Downloader complete"); 84 | } 85 | 86 | private static void log(String msg) { 87 | if (VERBOSE) { 88 | System.out.println(msg); 89 | } 90 | } 91 | 92 | } 93 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # https://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | wrapperVersion=3.3.2 18 | distributionType=source 19 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.10/apache-maven-3.9.10-bin.zip 20 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar 21 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | https://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 | https://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 | 203 | -------------------------------------------------------------------------------- /LICENSE_HEADER: -------------------------------------------------------------------------------- 1 | Copyright ${license.git.copyrightYears} the original author or authors. 2 | 3 | Licensed under the Apache License, Version 2.0 (the "License"); 4 | you may not use this file except in compliance with the License. 5 | You may obtain a copy of the License at 6 | 7 | https://www.apache.org/licenses/LICENSE-2.0 8 | 9 | Unless required by applicable law or agreed to in writing, software 10 | distributed under the License is distributed on an "AS IS" BASIS, 11 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | See the License for the specific language governing permissions and 13 | limitations under the License. 14 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | MyBatis Freemarker 2 | Copyright 2015-2023 3 | 4 | This product includes software developed by 5 | The MyBatis Team (http://www.mybatis.org/). 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | MyBatis Redis Extension 2 | ========================= 3 | 4 | [![Java CI](https://github.com/mybatis/redis-cache/actions/workflows/ci.yaml/badge.svg)](https://github.com/mybatis/redis-cache/actions/workflows/ci.yaml) 5 | [![Coverage Status](https://coveralls.io/repos/mybatis/redis-cache/badge.svg?branch=master&service=github)](https://coveralls.io/github/mybatis/redis-cache?branch=master) 6 | [![Maven central](https://maven-badges.herokuapp.com/maven-central/org.mybatis.caches/mybatis-redis/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.mybatis.caches/mybatis-redis) 7 | [![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/https/oss.sonatype.org/org.mybatis.caches/mybatis-redis.svg)](https://oss.sonatype.org/content/repositories/snapshots/org/mybatis/caches/mybatis-redis/) 8 | [![License](https://img.shields.io/:license-apache-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) 9 | 10 | ![mybatis-redis](https://mybatis.org/images/mybatis-logo.png) 11 | 12 | MyBatis-Redis extension Redis support for MyBatis Cache. 13 | 14 | Essentials 15 | ---------- 16 | 17 | * [See the docs](https://mybatis.org/redis-cache/) 18 | -------------------------------------------------------------------------------- /format.xml: -------------------------------------------------------------------------------- 1 | 2 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /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 | # https://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 | # Apache Maven Wrapper startup batch script, version 3.3.2 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | # e.g. to debug Maven itself, use 32 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | # ---------------------------------------------------------------------------- 35 | 36 | if [ -z "$MAVEN_SKIP_RC" ]; then 37 | 38 | if [ -f /usr/local/etc/mavenrc ]; then 39 | . /usr/local/etc/mavenrc 40 | fi 41 | 42 | if [ -f /etc/mavenrc ]; then 43 | . /etc/mavenrc 44 | fi 45 | 46 | if [ -f "$HOME/.mavenrc" ]; then 47 | . "$HOME/.mavenrc" 48 | fi 49 | 50 | fi 51 | 52 | # OS specific support. $var _must_ be set to either true or false. 53 | cygwin=false 54 | darwin=false 55 | mingw=false 56 | case "$(uname)" in 57 | CYGWIN*) cygwin=true ;; 58 | MINGW*) mingw=true ;; 59 | Darwin*) 60 | darwin=true 61 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 62 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 63 | if [ -z "$JAVA_HOME" ]; then 64 | if [ -x "/usr/libexec/java_home" ]; then 65 | JAVA_HOME="$(/usr/libexec/java_home)" 66 | export JAVA_HOME 67 | else 68 | JAVA_HOME="/Library/Java/Home" 69 | export JAVA_HOME 70 | fi 71 | fi 72 | ;; 73 | esac 74 | 75 | if [ -z "$JAVA_HOME" ]; then 76 | if [ -r /etc/gentoo-release ]; then 77 | JAVA_HOME=$(java-config --jre-home) 78 | fi 79 | fi 80 | 81 | # For Cygwin, ensure paths are in UNIX format before anything is touched 82 | if $cygwin; then 83 | [ -n "$JAVA_HOME" ] \ 84 | && JAVA_HOME=$(cygpath --unix "$JAVA_HOME") 85 | [ -n "$CLASSPATH" ] \ 86 | && CLASSPATH=$(cygpath --path --unix "$CLASSPATH") 87 | fi 88 | 89 | # For Mingw, ensure paths are in UNIX format before anything is touched 90 | if $mingw; then 91 | [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] \ 92 | && JAVA_HOME="$( 93 | cd "$JAVA_HOME" || ( 94 | echo "cannot cd into $JAVA_HOME." >&2 95 | exit 1 96 | ) 97 | pwd 98 | )" 99 | fi 100 | 101 | if [ -z "$JAVA_HOME" ]; then 102 | javaExecutable="$(which javac)" 103 | if [ -n "$javaExecutable" ] && ! [ "$(expr "$javaExecutable" : '\([^ ]*\)')" = "no" ]; then 104 | # readlink(1) is not available as standard on Solaris 10. 105 | readLink=$(which readlink) 106 | if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then 107 | if $darwin; then 108 | javaHome="$(dirname "$javaExecutable")" 109 | javaExecutable="$(cd "$javaHome" && pwd -P)/javac" 110 | else 111 | javaExecutable="$(readlink -f "$javaExecutable")" 112 | fi 113 | javaHome="$(dirname "$javaExecutable")" 114 | javaHome=$(expr "$javaHome" : '\(.*\)/bin') 115 | JAVA_HOME="$javaHome" 116 | export JAVA_HOME 117 | fi 118 | fi 119 | fi 120 | 121 | if [ -z "$JAVACMD" ]; then 122 | if [ -n "$JAVA_HOME" ]; then 123 | if [ -x "$JAVA_HOME/jre/sh/java" ]; then 124 | # IBM's JDK on AIX uses strange locations for the executables 125 | JAVACMD="$JAVA_HOME/jre/sh/java" 126 | else 127 | JAVACMD="$JAVA_HOME/bin/java" 128 | fi 129 | else 130 | JAVACMD="$( 131 | \unset -f command 2>/dev/null 132 | \command -v java 133 | )" 134 | fi 135 | fi 136 | 137 | if [ ! -x "$JAVACMD" ]; then 138 | echo "Error: JAVA_HOME is not defined correctly." >&2 139 | echo " We cannot execute $JAVACMD" >&2 140 | exit 1 141 | fi 142 | 143 | if [ -z "$JAVA_HOME" ]; then 144 | echo "Warning: JAVA_HOME environment variable is not set." >&2 145 | fi 146 | 147 | # traverses directory structure from process work directory to filesystem root 148 | # first directory with .mvn subdirectory is considered project base directory 149 | find_maven_basedir() { 150 | if [ -z "$1" ]; then 151 | echo "Path not specified to find_maven_basedir" >&2 152 | return 1 153 | fi 154 | 155 | basedir="$1" 156 | wdir="$1" 157 | while [ "$wdir" != '/' ]; do 158 | if [ -d "$wdir"/.mvn ]; then 159 | basedir=$wdir 160 | break 161 | fi 162 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 163 | if [ -d "${wdir}" ]; then 164 | wdir=$( 165 | cd "$wdir/.." || exit 1 166 | pwd 167 | ) 168 | fi 169 | # end of workaround 170 | done 171 | printf '%s' "$( 172 | cd "$basedir" || exit 1 173 | pwd 174 | )" 175 | } 176 | 177 | # concatenates all lines of a file 178 | concat_lines() { 179 | if [ -f "$1" ]; then 180 | # Remove \r in case we run on Windows within Git Bash 181 | # and check out the repository with auto CRLF management 182 | # enabled. Otherwise, we may read lines that are delimited with 183 | # \r\n and produce $'-Xarg\r' rather than -Xarg due to word 184 | # splitting rules. 185 | tr -s '\r\n' ' ' <"$1" 186 | fi 187 | } 188 | 189 | log() { 190 | if [ "$MVNW_VERBOSE" = true ]; then 191 | printf '%s\n' "$1" 192 | fi 193 | } 194 | 195 | BASE_DIR=$(find_maven_basedir "$(dirname "$0")") 196 | if [ -z "$BASE_DIR" ]; then 197 | exit 1 198 | fi 199 | 200 | MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 201 | export MAVEN_PROJECTBASEDIR 202 | log "$MAVEN_PROJECTBASEDIR" 203 | 204 | ########################################################################################## 205 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 206 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 207 | ########################################################################################## 208 | wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" 209 | if [ -r "$wrapperJarPath" ]; then 210 | log "Found $wrapperJarPath" 211 | else 212 | log "Couldn't find $wrapperJarPath, downloading it ..." 213 | 214 | if [ -n "$MVNW_REPOURL" ]; then 215 | wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar" 216 | else 217 | wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar" 218 | fi 219 | while IFS="=" read -r key value; do 220 | # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) 221 | safeValue=$(echo "$value" | tr -d '\r') 222 | case "$key" in wrapperUrl) 223 | wrapperUrl="$safeValue" 224 | break 225 | ;; 226 | esac 227 | done <"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" 228 | log "Downloading from: $wrapperUrl" 229 | 230 | if $cygwin; then 231 | wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") 232 | fi 233 | 234 | if command -v wget >/dev/null; then 235 | log "Found wget ... using wget" 236 | [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" 237 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 238 | wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 239 | else 240 | wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 241 | fi 242 | elif command -v curl >/dev/null; then 243 | log "Found curl ... using curl" 244 | [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" 245 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 246 | curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" 247 | else 248 | curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" 249 | fi 250 | else 251 | log "Falling back to using Java to download" 252 | javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" 253 | javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" 254 | # For Cygwin, switch paths to Windows format before running javac 255 | if $cygwin; then 256 | javaSource=$(cygpath --path --windows "$javaSource") 257 | javaClass=$(cygpath --path --windows "$javaClass") 258 | fi 259 | if [ -e "$javaSource" ]; then 260 | if [ ! -e "$javaClass" ]; then 261 | log " - Compiling MavenWrapperDownloader.java ..." 262 | ("$JAVA_HOME/bin/javac" "$javaSource") 263 | fi 264 | if [ -e "$javaClass" ]; then 265 | log " - Running MavenWrapperDownloader.java ..." 266 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" 267 | fi 268 | fi 269 | fi 270 | fi 271 | ########################################################################################## 272 | # End of extension 273 | ########################################################################################## 274 | 275 | # If specified, validate the SHA-256 sum of the Maven wrapper jar file 276 | wrapperSha256Sum="" 277 | while IFS="=" read -r key value; do 278 | case "$key" in wrapperSha256Sum) 279 | wrapperSha256Sum=$value 280 | break 281 | ;; 282 | esac 283 | done <"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" 284 | if [ -n "$wrapperSha256Sum" ]; then 285 | wrapperSha256Result=false 286 | if command -v sha256sum >/dev/null; then 287 | if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c >/dev/null 2>&1; then 288 | wrapperSha256Result=true 289 | fi 290 | elif command -v shasum >/dev/null; then 291 | if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c >/dev/null 2>&1; then 292 | wrapperSha256Result=true 293 | fi 294 | else 295 | echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 296 | echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." >&2 297 | exit 1 298 | fi 299 | if [ $wrapperSha256Result = false ]; then 300 | echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 301 | echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 302 | echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 303 | exit 1 304 | fi 305 | fi 306 | 307 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 308 | 309 | # For Cygwin, switch paths to Windows format before running java 310 | if $cygwin; then 311 | [ -n "$JAVA_HOME" ] \ 312 | && JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") 313 | [ -n "$CLASSPATH" ] \ 314 | && CLASSPATH=$(cygpath --path --windows "$CLASSPATH") 315 | [ -n "$MAVEN_PROJECTBASEDIR" ] \ 316 | && MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") 317 | fi 318 | 319 | # Provide a "standardized" way to retrieve the CLI args that will 320 | # work with both Windows and non-Windows executions. 321 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" 322 | export MAVEN_CMD_LINE_ARGS 323 | 324 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 325 | 326 | # shellcheck disable=SC2086 # safe args 327 | exec "$JAVACMD" \ 328 | $MAVEN_OPTS \ 329 | $MAVEN_DEBUG_OPTS \ 330 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 331 | "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 332 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 333 | -------------------------------------------------------------------------------- /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 https://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 Apache Maven Wrapper startup batch script, version 3.3.2 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 MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 28 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending 29 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 30 | @REM e.g. to debug Maven itself, use 31 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 32 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 33 | @REM ---------------------------------------------------------------------------- 34 | 35 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 36 | @echo off 37 | @REM set title of command window 38 | title %0 39 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' 40 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 41 | 42 | @REM set %HOME% to equivalent of $HOME 43 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 44 | 45 | @REM Execute a user defined script before this one 46 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 47 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 48 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* 49 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* 50 | :skipRcPre 51 | 52 | @setlocal 53 | 54 | set ERROR_CODE=0 55 | 56 | @REM To isolate internal variables from possible post scripts, we use another setlocal 57 | @setlocal 58 | 59 | @REM ==== START VALIDATION ==== 60 | if not "%JAVA_HOME%" == "" goto OkJHome 61 | 62 | echo. >&2 63 | echo Error: JAVA_HOME not found in your environment. >&2 64 | echo Please set the JAVA_HOME variable in your environment to match the >&2 65 | echo location of your Java installation. >&2 66 | echo. >&2 67 | goto error 68 | 69 | :OkJHome 70 | if exist "%JAVA_HOME%\bin\java.exe" goto init 71 | 72 | echo. >&2 73 | echo Error: JAVA_HOME is set to an invalid directory. >&2 74 | echo JAVA_HOME = "%JAVA_HOME%" >&2 75 | echo Please set the JAVA_HOME variable in your environment to match the >&2 76 | echo location of your Java installation. >&2 77 | echo. >&2 78 | goto error 79 | 80 | @REM ==== END VALIDATION ==== 81 | 82 | :init 83 | 84 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 85 | @REM Fallback to current working directory if not found. 86 | 87 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 88 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 89 | 90 | set EXEC_DIR=%CD% 91 | set WDIR=%EXEC_DIR% 92 | :findBaseDir 93 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 94 | cd .. 95 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 96 | set WDIR=%CD% 97 | goto findBaseDir 98 | 99 | :baseDirFound 100 | set MAVEN_PROJECTBASEDIR=%WDIR% 101 | cd "%EXEC_DIR%" 102 | goto endDetectBaseDir 103 | 104 | :baseDirNotFound 105 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 106 | cd "%EXEC_DIR%" 107 | 108 | :endDetectBaseDir 109 | 110 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 111 | 112 | @setlocal EnableExtensions EnableDelayedExpansion 113 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 114 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 115 | 116 | :endReadAdditionalConfig 117 | 118 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 119 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 120 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 121 | 122 | set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar" 123 | 124 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 125 | IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B 126 | ) 127 | 128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 130 | if exist %WRAPPER_JAR% ( 131 | if "%MVNW_VERBOSE%" == "true" ( 132 | echo Found %WRAPPER_JAR% 133 | ) 134 | ) else ( 135 | if not "%MVNW_REPOURL%" == "" ( 136 | SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar" 137 | ) 138 | if "%MVNW_VERBOSE%" == "true" ( 139 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 140 | echo Downloading from: %WRAPPER_URL% 141 | ) 142 | 143 | powershell -Command "&{"^ 144 | "$webclient = new-object System.Net.WebClient;"^ 145 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ 146 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ 147 | "}"^ 148 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ 149 | "}" 150 | if "%MVNW_VERBOSE%" == "true" ( 151 | echo Finished downloading %WRAPPER_JAR% 152 | ) 153 | ) 154 | @REM End of extension 155 | 156 | @REM If specified, validate the SHA-256 sum of the Maven wrapper jar file 157 | SET WRAPPER_SHA_256_SUM="" 158 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 159 | IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B 160 | ) 161 | IF NOT %WRAPPER_SHA_256_SUM%=="" ( 162 | powershell -Command "&{"^ 163 | "Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash;"^ 164 | "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ 165 | "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ 166 | " Write-Error 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ 167 | " Write-Error 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ 168 | " Write-Error 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ 169 | " exit 1;"^ 170 | "}"^ 171 | "}" 172 | if ERRORLEVEL 1 goto error 173 | ) 174 | 175 | @REM Provide a "standardized" way to retrieve the CLI args that will 176 | @REM work with both Windows and non-Windows executions. 177 | set MAVEN_CMD_LINE_ARGS=%* 178 | 179 | %MAVEN_JAVA_EXE% ^ 180 | %JVM_CONFIG_MAVEN_PROPS% ^ 181 | %MAVEN_OPTS% ^ 182 | %MAVEN_DEBUG_OPTS% ^ 183 | -classpath %WRAPPER_JAR% ^ 184 | "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ 185 | %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 186 | if ERRORLEVEL 1 goto error 187 | goto end 188 | 189 | :error 190 | set ERROR_CODE=1 191 | 192 | :end 193 | @endlocal & set ERROR_CODE=%ERROR_CODE% 194 | 195 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost 196 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 197 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" 198 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" 199 | :skipRcPost 200 | 201 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 202 | if "%MAVEN_BATCH_PAUSE%"=="on" pause 203 | 204 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% 205 | 206 | cmd /C exit /B %ERROR_CODE% 207 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 19 | 20 | 21 | 4.0.0 22 | 23 | 24 | org.mybatis 25 | mybatis-parent 26 | 50 27 | 28 | 29 | 30 | org.mybatis.caches 31 | mybatis-redis 32 | 1.0.1-SNAPSHOT 33 | 34 | mybatis-redis 35 | Redis support for MyBatis Cache 36 | https://github.com/mybatis/redis-cache/ 37 | 38 | 2015 39 | 40 | 41 | scm:git:ssh://git@github.com/mybatis/redis-cache.git 42 | scm:git:ssh://git@github.com/mybatis/redis-cache.git 43 | HEAD 44 | http://github.com/mybatis/redis-cache/ 45 | 46 | 47 | GitHub Issue Management 48 | https://github.com/mybatis/redis-cache/issues 49 | 50 | 51 | GitHub Actions 52 | https://github.com/mybatis/redis-cache/actions 53 | 54 | 55 | 56 | gh-pages-scm 57 | Mybatis GitHub Pages 58 | scm:git:ssh://git@github.com/mybatis/redis-cache.git 59 | 60 | 61 | 62 | 63 | 64 | 8 65 | 8 66 | 67 | 1.0.3 68 | org.mybatis.caches.redis.* 69 | Cache 70 | org.mybatis.caches.redis 71 | 72 | 73 | 1736569293 74 | 75 | 76 | 77 | 78 | 79 | org.mybatis 80 | mybatis 81 | 3.5.19 82 | provided 83 | 84 | 85 | 86 | 87 | redis.clients 88 | jedis 89 | 6.0.0 90 | compile 91 | 92 | 93 | 94 | 95 | com.esotericsoftware.kryo 96 | kryo5 97 | 5.6.2 98 | compile 99 | true 100 | 101 | 102 | 103 | 104 | org.junit.jupiter 105 | junit-jupiter-engine 106 | 5.13.3 107 | test 108 | 109 | 110 | org.slf4j 111 | slf4j-simple 112 | 2.0.17 113 | test 114 | 115 | 116 | 117 | 118 | 119 | 120 | noTest 121 | 122 | 123 | noTest 124 | true 125 | 126 | 127 | 128 | 129 | 130 | org.apache.maven.plugins 131 | maven-surefire-plugin 132 | 133 | true 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | windows 142 | 143 | 144 | windows 145 | 146 | 147 | 148 | 149 | 150 | org.apache.maven.plugins 151 | maven-surefire-plugin 152 | 153 | true 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "config:recommended" 5 | ] 6 | } 7 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/caches/redis/DummyReadWriteLock.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis; 17 | 18 | import java.util.concurrent.TimeUnit; 19 | import java.util.concurrent.locks.Condition; 20 | import java.util.concurrent.locks.Lock; 21 | import java.util.concurrent.locks.ReadWriteLock; 22 | 23 | /** 24 | * @author Iwao AVE! 25 | */ 26 | class DummyReadWriteLock implements ReadWriteLock { 27 | 28 | private Lock lock = new DummyLock(); 29 | 30 | @Override 31 | public Lock readLock() { 32 | return lock; 33 | } 34 | 35 | @Override 36 | public Lock writeLock() { 37 | return lock; 38 | } 39 | 40 | static class DummyLock implements Lock { 41 | 42 | @Override 43 | public void lock() { 44 | // Not implemented 45 | } 46 | 47 | @Override 48 | public void lockInterruptibly() throws InterruptedException { 49 | // Not implemented 50 | } 51 | 52 | @Override 53 | public boolean tryLock() { 54 | return true; 55 | } 56 | 57 | @Override 58 | public boolean tryLock(long paramLong, TimeUnit paramTimeUnit) throws InterruptedException { 59 | return true; 60 | } 61 | 62 | @Override 63 | public void unlock() { 64 | // Not implemented 65 | } 66 | 67 | @Override 68 | public Condition newCondition() { 69 | return null; 70 | } 71 | } 72 | 73 | } 74 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/caches/redis/JDKSerializer.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2023 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis; 17 | 18 | import java.io.ByteArrayInputStream; 19 | import java.io.ByteArrayOutputStream; 20 | import java.io.ObjectInputStream; 21 | import java.io.ObjectOutputStream; 22 | 23 | import org.apache.ibatis.cache.CacheException; 24 | 25 | public enum JDKSerializer implements Serializer { 26 | // Enum singleton, which is preferred approach since Java 1.5 27 | INSTANCE; 28 | 29 | private JDKSerializer() { 30 | // prevent instantiation 31 | } 32 | 33 | @Override 34 | public byte[] serialize(Object object) { 35 | try (ByteArrayOutputStream baos = new ByteArrayOutputStream(); 36 | ObjectOutputStream oos = new ObjectOutputStream(baos)) { 37 | oos.writeObject(object); 38 | return baos.toByteArray(); 39 | } catch (Exception e) { 40 | throw new CacheException(e); 41 | } 42 | } 43 | 44 | @Override 45 | public Object unserialize(byte[] bytes) { 46 | if (bytes == null) { 47 | return null; 48 | } 49 | try (ByteArrayInputStream bais = new ByteArrayInputStream(bytes); 50 | ObjectInputStream ois = new ObjectInputStream(bais)) { 51 | return ois.readObject(); 52 | } catch (Exception e) { 53 | throw new CacheException(e); 54 | } 55 | } 56 | 57 | } 58 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/caches/redis/KryoSerializer.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2023 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis; 17 | 18 | import com.esotericsoftware.kryo.kryo5.Kryo; 19 | import com.esotericsoftware.kryo.kryo5.io.Input; 20 | import com.esotericsoftware.kryo.kryo5.io.Output; 21 | 22 | import java.util.Arrays; 23 | import java.util.Set; 24 | import java.util.concurrent.ConcurrentHashMap; 25 | 26 | /** 27 | * SerializeUtil with Kryo, which is faster and less space consuming. 28 | * 29 | * @author Lei Jiang(ladd.cn@gmail.com) 30 | */ 31 | public enum KryoSerializer implements Serializer { 32 | // Enum singleton, which is preferred approach since Java 1.5 33 | INSTANCE; 34 | 35 | /** 36 | * kryo is thread-unsafe, use ThreadLocal. 37 | */ 38 | private ThreadLocal kryos = ThreadLocal.withInitial(Kryo::new); 39 | 40 | /** 41 | * Classes which can not resolved by default kryo serializer, which occurs very 42 | * rare(https://github.com/EsotericSoftware/kryo#using-standard-java-serialization) For these classes, we will use 43 | * fallbackSerializer(use JDKSerializer now) to resolve. 44 | */ 45 | private Set> unnormalClassSet; 46 | 47 | /** 48 | * Hash codes of unnormal bytes which can not resolved by default kryo serializer, which will be resolved by 49 | * fallbackSerializer 50 | */ 51 | private Set unnormalBytesHashCodeSet; 52 | private Serializer fallbackSerializer; 53 | 54 | private KryoSerializer() { 55 | unnormalClassSet = ConcurrentHashMap.newKeySet(); 56 | unnormalBytesHashCodeSet = ConcurrentHashMap.newKeySet(); 57 | fallbackSerializer = JDKSerializer.INSTANCE;// use JDKSerializer as fallback 58 | } 59 | 60 | @Override 61 | public byte[] serialize(Object object) { 62 | if (unnormalClassSet.contains(object.getClass())) { 63 | // For unnormal class 64 | return fallbackSerializer.serialize(object); 65 | } 66 | 67 | /** 68 | * In the following cases: 1. This class occurs for the first time. 2. This class have occurred and can be resolved 69 | * by default kryo serializer 70 | */ 71 | try (Output output = new Output(200, -1)) { 72 | kryos.get().writeClassAndObject(output, object); 73 | return output.toBytes(); 74 | } catch (Exception e) { 75 | // For unnormal class occurred for the first time, exception will be thrown 76 | unnormalClassSet.add(object.getClass()); 77 | return fallbackSerializer.serialize(object);// use fallback Serializer to resolve 78 | } 79 | } 80 | 81 | @Override 82 | public Object unserialize(byte[] bytes) { 83 | if (bytes == null) { 84 | return null; 85 | } 86 | int hashCode = Arrays.hashCode(bytes); 87 | if (unnormalBytesHashCodeSet.contains(hashCode)) { 88 | // For unnormal bytes 89 | return fallbackSerializer.unserialize(bytes); 90 | } 91 | 92 | /** 93 | * In the following cases: 1. This bytes occurs for the first time. 2. This bytes have occurred and can be resolved 94 | * by default kryo serializer 95 | */ 96 | try (Input input = new Input()) { 97 | input.setBuffer(bytes); 98 | return kryos.get().readClassAndObject(input); 99 | } catch (Exception e) { 100 | // For unnormal bytes occurred for the first time, exception will be thrown 101 | unnormalBytesHashCodeSet.add(hashCode); 102 | return fallbackSerializer.unserialize(bytes);// use fallback Serializer to resolve 103 | } 104 | } 105 | 106 | } 107 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/caches/redis/RedisCache.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2023 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis; 17 | 18 | import java.util.Map; 19 | import java.util.concurrent.locks.ReadWriteLock; 20 | 21 | import org.apache.ibatis.cache.Cache; 22 | 23 | import redis.clients.jedis.Jedis; 24 | import redis.clients.jedis.JedisPool; 25 | 26 | /** 27 | * Cache adapter for Redis. 28 | * 29 | * @author Eduardo Macarron 30 | */ 31 | public final class RedisCache implements Cache { 32 | 33 | private final ReadWriteLock readWriteLock = new DummyReadWriteLock(); 34 | 35 | private String id; 36 | 37 | private static JedisPool pool; 38 | 39 | private final RedisConfig redisConfig; 40 | 41 | private Integer timeout; 42 | 43 | public RedisCache(final String id) { 44 | if (id == null) { 45 | throw new IllegalArgumentException("Cache instances require an ID"); 46 | } 47 | this.id = id; 48 | redisConfig = RedisConfigurationBuilder.getInstance().parseConfiguration(); 49 | pool = new JedisPool(redisConfig, redisConfig.getHost(), redisConfig.getPort(), redisConfig.getConnectionTimeout(), 50 | redisConfig.getSoTimeout(), redisConfig.getPassword(), redisConfig.getDatabase(), redisConfig.getClientName(), 51 | redisConfig.isSsl(), redisConfig.getSslSocketFactory(), redisConfig.getSslParameters(), 52 | redisConfig.getHostnameVerifier()); 53 | } 54 | 55 | // TODO Review this is UNUSED 56 | private Object execute(RedisCallback callback) { 57 | Jedis jedis = pool.getResource(); 58 | try { 59 | return callback.doWithRedis(jedis); 60 | } finally { 61 | jedis.close(); 62 | } 63 | } 64 | 65 | @Override 66 | public String getId() { 67 | return this.id; 68 | } 69 | 70 | @Override 71 | public int getSize() { 72 | return (Integer) execute(jedis -> { 73 | Map result = jedis.hgetAll(id.getBytes()); 74 | return result.size(); 75 | }); 76 | } 77 | 78 | @Override 79 | public void putObject(final Object key, final Object value) { 80 | execute(jedis -> { 81 | final byte[] idBytes = id.getBytes(); 82 | jedis.hset(idBytes, key.toString().getBytes(), redisConfig.getSerializer().serialize(value)); 83 | if (timeout != null && jedis.ttl(idBytes) == -1) { 84 | jedis.expire(idBytes, timeout); 85 | } 86 | return null; 87 | }); 88 | } 89 | 90 | @Override 91 | public Object getObject(final Object key) { 92 | return execute( 93 | jedis -> redisConfig.getSerializer().unserialize(jedis.hget(id.getBytes(), key.toString().getBytes()))); 94 | } 95 | 96 | @Override 97 | public Object removeObject(final Object key) { 98 | return execute(jedis -> jedis.hdel(id, key.toString())); 99 | } 100 | 101 | @Override 102 | public void clear() { 103 | execute(jedis -> { 104 | jedis.del(id); 105 | return null; 106 | }); 107 | } 108 | 109 | @Override 110 | public ReadWriteLock getReadWriteLock() { 111 | return readWriteLock; 112 | } 113 | 114 | @Override 115 | public String toString() { 116 | return "Redis {" + id + "}"; 117 | } 118 | 119 | public void setTimeout(Integer timeout) { 120 | this.timeout = timeout; 121 | } 122 | 123 | } 124 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/caches/redis/RedisCallback.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis; 17 | 18 | import redis.clients.jedis.Jedis; 19 | 20 | public interface RedisCallback { 21 | 22 | Object doWithRedis(Jedis jedis); 23 | } 24 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/caches/redis/RedisConfig.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2023 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis; 17 | 18 | import javax.net.ssl.HostnameVerifier; 19 | import javax.net.ssl.SSLParameters; 20 | import javax.net.ssl.SSLSocketFactory; 21 | 22 | import redis.clients.jedis.JedisPoolConfig; 23 | import redis.clients.jedis.Protocol; 24 | 25 | public class RedisConfig extends JedisPoolConfig { 26 | 27 | private String host = Protocol.DEFAULT_HOST; 28 | private int port = Protocol.DEFAULT_PORT; 29 | private int connectionTimeout = Protocol.DEFAULT_TIMEOUT; 30 | private int soTimeout = Protocol.DEFAULT_TIMEOUT; 31 | private String password; 32 | private int database = Protocol.DEFAULT_DATABASE; 33 | private String clientName; 34 | private boolean ssl; 35 | private SSLSocketFactory sslSocketFactory; 36 | private SSLParameters sslParameters; 37 | private HostnameVerifier hostnameVerifier; 38 | private Serializer serializer = JDKSerializer.INSTANCE; 39 | 40 | public boolean isSsl() { 41 | return ssl; 42 | } 43 | 44 | public void setSsl(boolean ssl) { 45 | this.ssl = ssl; 46 | } 47 | 48 | public SSLSocketFactory getSslSocketFactory() { 49 | return sslSocketFactory; 50 | } 51 | 52 | public void setSslSocketFactory(SSLSocketFactory sslSocketFactory) { 53 | this.sslSocketFactory = sslSocketFactory; 54 | } 55 | 56 | public SSLParameters getSslParameters() { 57 | return sslParameters; 58 | } 59 | 60 | public void setSslParameters(SSLParameters sslParameters) { 61 | this.sslParameters = sslParameters; 62 | } 63 | 64 | public HostnameVerifier getHostnameVerifier() { 65 | return hostnameVerifier; 66 | } 67 | 68 | public void setHostnameVerifier(HostnameVerifier hostnameVerifier) { 69 | this.hostnameVerifier = hostnameVerifier; 70 | } 71 | 72 | public String getHost() { 73 | return host; 74 | } 75 | 76 | public void setHost(String host) { 77 | if (host == null || host.isEmpty()) { 78 | host = Protocol.DEFAULT_HOST; 79 | } 80 | this.host = host; 81 | } 82 | 83 | public int getPort() { 84 | return port; 85 | } 86 | 87 | public void setPort(int port) { 88 | this.port = port; 89 | } 90 | 91 | public String getPassword() { 92 | return password; 93 | } 94 | 95 | public void setPassword(String password) { 96 | if (password == null || password.isEmpty()) { 97 | password = null; 98 | } 99 | this.password = password; 100 | } 101 | 102 | public int getDatabase() { 103 | return database; 104 | } 105 | 106 | public void setDatabase(int database) { 107 | this.database = database; 108 | } 109 | 110 | public String getClientName() { 111 | return clientName; 112 | } 113 | 114 | public void setClientName(String clientName) { 115 | if (clientName == null || clientName.isEmpty()) { 116 | clientName = null; 117 | } 118 | this.clientName = clientName; 119 | } 120 | 121 | public int getConnectionTimeout() { 122 | return connectionTimeout; 123 | } 124 | 125 | public void setConnectionTimeout(int connectionTimeout) { 126 | this.connectionTimeout = connectionTimeout; 127 | } 128 | 129 | public int getSoTimeout() { 130 | return soTimeout; 131 | } 132 | 133 | public void setSoTimeout(int soTimeout) { 134 | this.soTimeout = soTimeout; 135 | } 136 | 137 | public Serializer getSerializer() { 138 | return serializer; 139 | } 140 | 141 | public void setSerializer(Serializer serializer) { 142 | this.serializer = serializer; 143 | } 144 | 145 | } 146 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/caches/redis/RedisConfigurationBuilder.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2023 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis; 17 | 18 | import java.io.IOException; 19 | import java.io.InputStream; 20 | import java.util.Arrays; 21 | import java.util.Map; 22 | import java.util.Properties; 23 | 24 | import org.apache.ibatis.cache.CacheException; 25 | import org.apache.ibatis.io.Resources; 26 | import org.apache.ibatis.reflection.MetaObject; 27 | import org.apache.ibatis.reflection.SystemMetaObject; 28 | 29 | /** 30 | * Converter from the Config to a proper {@link RedisConfig}. 31 | * 32 | * @author Eduardo Macarron 33 | */ 34 | final class RedisConfigurationBuilder { 35 | 36 | /** 37 | * This class instance. 38 | */ 39 | private static final RedisConfigurationBuilder INSTANCE = new RedisConfigurationBuilder(); 40 | 41 | protected static final String SYSTEM_PROPERTY_REDIS_PROPERTIES_FILENAME = "redis.properties.filename"; 42 | 43 | protected static final String REDIS_RESOURCE = "redis.properties"; 44 | 45 | /** 46 | * Hidden constructor, this class can't be instantiated. 47 | */ 48 | private RedisConfigurationBuilder() { 49 | } 50 | 51 | /** 52 | * Return this class instance. 53 | * 54 | * @return this class instance. 55 | */ 56 | public static RedisConfigurationBuilder getInstance() { 57 | return INSTANCE; 58 | } 59 | 60 | /** 61 | * Parses the Config and builds a new {@link RedisConfig}. 62 | * 63 | * @return the converted {@link RedisConfig}. 64 | */ 65 | public RedisConfig parseConfiguration() { 66 | return parseConfiguration(getClass().getClassLoader()); 67 | } 68 | 69 | /** 70 | * Parses the Config and builds a new {@link RedisConfig}. 71 | * 72 | * @param the 73 | * {@link ClassLoader} used to load the {@code memcached.properties} file in classpath. 74 | * 75 | * @return the converted {@link RedisConfig}. 76 | */ 77 | public RedisConfig parseConfiguration(ClassLoader classLoader) { 78 | Properties config = new Properties(); 79 | 80 | String redisPropertiesFilename = System.getProperty(SYSTEM_PROPERTY_REDIS_PROPERTIES_FILENAME, REDIS_RESOURCE); 81 | 82 | try (InputStream input = classLoader.getResourceAsStream(redisPropertiesFilename)) { 83 | if (input != null) { 84 | config.load(input); 85 | } 86 | } catch (IOException e) { 87 | throw new RuntimeException( 88 | "An error occurred while reading classpath property '" + redisPropertiesFilename + "', see nested exceptions", 89 | e); 90 | } 91 | 92 | RedisConfig jedisConfig = new RedisConfig(); 93 | setConfigProperties(config, jedisConfig); 94 | return jedisConfig; 95 | } 96 | 97 | private void setConfigProperties(Properties properties, RedisConfig jedisConfig) { 98 | if (properties != null) { 99 | MetaObject metaCache = SystemMetaObject.forObject(jedisConfig); 100 | for (Map.Entry entry : properties.entrySet()) { 101 | String name = (String) entry.getKey(); 102 | // All prefix of 'redis.' on property values 103 | if (name != null && name.startsWith("redis.")) { 104 | name = name.substring(6); 105 | } else { 106 | // Skip non prefixed properties 107 | continue; 108 | } 109 | String value = (String) entry.getValue(); 110 | if ("serializer".equals(name)) { 111 | if ("kryo".equalsIgnoreCase(value)) { 112 | jedisConfig.setSerializer(KryoSerializer.INSTANCE); 113 | } else if (!"jdk".equalsIgnoreCase(value)) { 114 | // Custom serializer is not supported yet. 115 | throw new CacheException("Unknown serializer: '" + value + "'"); 116 | } 117 | } else if (Arrays.asList("sslSocketFactory", "sslParameters", "hostnameVerifier").contains(name)) { 118 | setInstance(metaCache, name, value); 119 | } else if (metaCache.hasSetter(name)) { 120 | Class type = metaCache.getSetterType(name); 121 | if (String.class == type) { 122 | metaCache.setValue(name, value); 123 | } else if (int.class == type || Integer.class == type) { 124 | metaCache.setValue(name, Integer.valueOf(value)); 125 | } else if (long.class == type || Long.class == type) { 126 | metaCache.setValue(name, Long.valueOf(value)); 127 | } else if (short.class == type || Short.class == type) { 128 | metaCache.setValue(name, Short.valueOf(value)); 129 | } else if (byte.class == type || Byte.class == type) { 130 | metaCache.setValue(name, Byte.valueOf(value)); 131 | } else if (float.class == type || Float.class == type) { 132 | metaCache.setValue(name, Float.valueOf(value)); 133 | } else if (boolean.class == type || Boolean.class == type) { 134 | metaCache.setValue(name, Boolean.valueOf(value)); 135 | } else if (double.class == type || Double.class == type) { 136 | metaCache.setValue(name, Double.valueOf(value)); 137 | } else { 138 | throw new CacheException("Unsupported property type: '" + name + "' of type " + type); 139 | } 140 | } 141 | } 142 | } 143 | } 144 | 145 | protected void setInstance(MetaObject metaCache, String name, String value) { 146 | if (value == null || value.isEmpty()) { 147 | return; 148 | } 149 | Object instance; 150 | try { 151 | Class clazz = Resources.classForName(value); 152 | instance = clazz.getDeclaredConstructor().newInstance(); 153 | } catch (Exception e) { 154 | throw new CacheException("Could not instantiate class: '" + value + "'.", e); 155 | } 156 | metaCache.setValue(name, instance); 157 | } 158 | 159 | } 160 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/caches/redis/Serializer.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2023 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis; 17 | 18 | public interface Serializer { 19 | 20 | /** 21 | * Serialize method 22 | * 23 | * @param object 24 | * 25 | * @return serialized bytes 26 | */ 27 | byte[] serialize(Object object); 28 | 29 | /** 30 | * Unserialize method 31 | * 32 | * @param bytes 33 | * 34 | * @return unserialized object 35 | */ 36 | Object unserialize(byte[] bytes); 37 | 38 | } 39 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/caches/redis/package-info.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | /** 17 | * Contains Redis support for MyBatis Cache. 18 | */ 19 | package org.mybatis.caches.redis; 20 | -------------------------------------------------------------------------------- /src/site/site.xml: -------------------------------------------------------------------------------- 1 | 2 | 19 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /src/site/xdoc/index.xml.vm: -------------------------------------------------------------------------------- 1 | 2 | 19 | 22 | 23 | 24 | MyBatis Redis | Reference Documentation 25 | The MyBatis Team 26 | 27 | 28 | 29 |
30 | 31 |

Redis is an in-memory key-value store for small chunks of arbitrary data 32 | (strings, objects) from results of database calls, API calls, or page rendering.

33 |

The Redis integration is built on top of the Jedis client, written by Jonathan Leibiusky.

34 |

Users that want to use Redis into their applications, have to download the 35 | zip bundle, decompress it and add the jars in the classpath; 36 | Apache Maven users instead can simply add in 37 | the pom.xml the following dependency:

38 | 39 | ... 40 | 41 | ${project.groupId} 42 | ${project.artifactId} 43 | ${project.version} 44 | 45 | ... 46 | ]]> 47 |

then, just configure it in the mapper XML

48 | 49 | 50 | ... 51 | ]]> 52 | 53 |

The Redis cache is configurable by putting the /redis.properties classpath resource; 54 | if not found, the client will use the default setting.

55 | 56 |

Any property found in the configuration file will be set as a property to the bean JedisConfigPool. 57 | There is an additional parameter redis.host to set the Redis server host name; if not set "localhost" will be used.

58 | 59 |

All properties are prefixed with 'redis' to avoid issues with other property types such as host.

60 | 61 |

To set cache TTL, set the value in seconds to timeout property.

62 | 63 | 64 | ]]> 65 | 66 |
67 | 68 | 69 | 70 | -------------------------------------------------------------------------------- /src/test/java/org/mybatis/caches/redis/RedisConfigurationBuilderTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2023 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis; 17 | 18 | import static org.junit.jupiter.api.Assertions.assertEquals; 19 | import static org.junit.jupiter.api.Assertions.assertFalse; 20 | import static org.junit.jupiter.api.Assertions.assertNull; 21 | import static org.junit.jupiter.api.Assertions.assertTrue; 22 | 23 | import org.junit.jupiter.api.AfterEach; 24 | import org.junit.jupiter.api.Test; 25 | import org.mybatis.caches.redis.sslconfig.TestHostnameVerifier; 26 | import org.mybatis.caches.redis.sslconfig.TestSSLParameters; 27 | import org.mybatis.caches.redis.sslconfig.TestSSLSocketFactory; 28 | 29 | class RedisConfigurationBuilderTest { 30 | 31 | @Test 32 | void testDefaults() throws Exception { 33 | System.setProperty(RedisConfigurationBuilder.SYSTEM_PROPERTY_REDIS_PROPERTIES_FILENAME, "no-such-file.properties"); 34 | RedisConfig redisConfig = RedisConfigurationBuilder.getInstance() 35 | .parseConfiguration(this.getClass().getClassLoader()); 36 | assertEquals(JDKSerializer.class, redisConfig.getSerializer().getClass()); 37 | assertFalse(redisConfig.isSsl()); 38 | assertNull(redisConfig.getSslSocketFactory()); 39 | assertNull(redisConfig.getSslParameters()); 40 | assertNull(redisConfig.getHostnameVerifier()); 41 | } 42 | 43 | @Test 44 | void test1() throws Exception { 45 | System.setProperty(RedisConfigurationBuilder.SYSTEM_PROPERTY_REDIS_PROPERTIES_FILENAME, "test1.properties"); 46 | RedisConfig redisConfig = RedisConfigurationBuilder.getInstance() 47 | .parseConfiguration(this.getClass().getClassLoader()); 48 | assertEquals(KryoSerializer.class, redisConfig.getSerializer().getClass()); 49 | assertTrue(redisConfig.isSsl()); 50 | assertEquals(TestSSLSocketFactory.class, redisConfig.getSslSocketFactory().getClass()); 51 | assertEquals(TestSSLParameters.class, redisConfig.getSslParameters().getClass()); 52 | assertEquals(TestHostnameVerifier.class, redisConfig.getHostnameVerifier().getClass()); 53 | } 54 | 55 | @AfterEach 56 | public void after() { 57 | System.setProperty(RedisConfigurationBuilder.SYSTEM_PROPERTY_REDIS_PROPERTIES_FILENAME, 58 | RedisConfigurationBuilder.REDIS_RESOURCE); 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /src/test/java/org/mybatis/caches/redis/RedisTestCase.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2023 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis; 17 | 18 | import static org.junit.jupiter.api.Assertions.assertEquals; 19 | import static org.junit.jupiter.api.Assertions.assertNotNull; 20 | import static org.junit.jupiter.api.Assertions.assertNull; 21 | import static org.junit.jupiter.api.Assertions.assertThrows; 22 | 23 | import org.junit.jupiter.api.BeforeAll; 24 | import org.junit.jupiter.api.Test; 25 | 26 | /** 27 | * Test with Ubuntu sudo apt-get install redis-server execute the test 28 | */ 29 | final class RedisTestCase { 30 | 31 | private static final String DEFAULT_ID = "REDIS"; 32 | 33 | private static RedisCache cache; 34 | 35 | @BeforeAll 36 | static void newCache() { 37 | cache = new RedisCache(DEFAULT_ID); 38 | } 39 | 40 | @Test 41 | void shouldDemonstrateCopiesAreEqual() { 42 | for (int i = 0; i < 1000; i++) { 43 | cache.putObject(i, i); 44 | assertEquals(i, cache.getObject(i)); 45 | } 46 | } 47 | 48 | @Test 49 | void shouldRemoveItemOnDemand() { 50 | cache.putObject(0, 0); 51 | assertNotNull(cache.getObject(0)); 52 | cache.removeObject(0); 53 | assertNull(cache.getObject(0)); 54 | } 55 | 56 | @Test 57 | void shouldFlushAllItemsOnDemand() { 58 | for (int i = 0; i < 5; i++) { 59 | cache.putObject(i, i); 60 | } 61 | assertNotNull(cache.getObject(0)); 62 | assertNotNull(cache.getObject(4)); 63 | cache.clear(); 64 | assertNull(cache.getObject(0)); 65 | assertNull(cache.getObject(4)); 66 | } 67 | 68 | @Test 69 | void shouldNotCreateCache() { 70 | assertThrows(IllegalArgumentException.class, () -> { 71 | cache = new RedisCache(null); 72 | }); 73 | } 74 | 75 | @Test 76 | void shouldVerifyCacheId() { 77 | assertEquals("REDIS", cache.getId()); 78 | } 79 | 80 | @Test 81 | void shouldVerifyToString() { 82 | assertEquals("Redis {REDIS}", cache.toString()); 83 | } 84 | 85 | @Test 86 | void shouldDeleteExpiredCache() throws Exception { 87 | // set timeout to 3 secs 88 | cache.setTimeout(3); 89 | cache.putObject(0, 0); 90 | Thread.sleep(2000); 91 | cache.putObject(1, 1); 92 | // 2 secs : not expired yet 93 | assertEquals(0, cache.getObject(0)); 94 | Thread.sleep(2000); 95 | // 4 secs : should be expired 96 | assertNull(cache.getObject(0)); 97 | assertNull(cache.getObject(1)); 98 | // Make sure timeout is re-set 99 | cache.putObject(2, 2); 100 | Thread.sleep(2000); 101 | // 2 secs : not expired yet 102 | cache.putObject(3, 3); 103 | assertEquals(2, cache.getObject(2)); 104 | Thread.sleep(2000); 105 | // 4 secs : should be expired 106 | assertNull(cache.getObject(2)); 107 | assertNull(cache.getObject(3)); 108 | } 109 | } 110 | -------------------------------------------------------------------------------- /src/test/java/org/mybatis/caches/redis/SerializerTestCase.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2023 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis; 17 | 18 | import static org.junit.jupiter.api.Assertions.assertEquals; 19 | import static org.junit.jupiter.api.Assertions.assertNull; 20 | 21 | import java.io.ByteArrayOutputStream; 22 | import java.io.IOException; 23 | import java.io.InputStream; 24 | 25 | import org.junit.jupiter.api.BeforeEach; 26 | import org.junit.jupiter.api.Test; 27 | 28 | class SerializerTestCase { 29 | 30 | int max = 1000000; 31 | 32 | Serializer kryoSerializer; 33 | Serializer jdkSerializer; 34 | 35 | @BeforeEach 36 | void setup() { 37 | kryoSerializer = KryoSerializer.INSTANCE; 38 | jdkSerializer = JDKSerializer.INSTANCE; 39 | } 40 | 41 | @Test 42 | void testKryoUnserializeNull() { 43 | Object obj = kryoSerializer.unserialize(null); 44 | assertNull(obj); 45 | } 46 | 47 | @Test 48 | void testJDKUnserializeNull() { 49 | Object obj = jdkSerializer.unserialize(null); 50 | assertNull(obj); 51 | } 52 | 53 | @Test 54 | void testKryoSerialize() { 55 | SimpleBeanStudentInfo rawSimpleBean = new SimpleBeanStudentInfo(); 56 | 57 | for (int i = 0; i != max; ++i) { 58 | kryoSerializer.serialize(rawSimpleBean); 59 | } 60 | 61 | byte[] serialBytes = kryoSerializer.serialize(rawSimpleBean); 62 | SimpleBeanStudentInfo unserializeSimpleBean = (SimpleBeanStudentInfo) kryoSerializer.unserialize(serialBytes); 63 | 64 | for (int i = 0; i != max; ++i) { 65 | kryoSerializer.unserialize(serialBytes); 66 | } 67 | 68 | assertEquals(rawSimpleBean, unserializeSimpleBean); 69 | 70 | } 71 | 72 | @Test 73 | void testKryoFallbackSerialize() throws IOException { 74 | 75 | SimpleBeanStudentInfo rawSimpleBean = new SimpleBeanStudentInfo(); 76 | byte[] serialBytes = jdkSerializer.serialize(rawSimpleBean); 77 | 78 | SimpleBeanStudentInfo unserializeSimpleBean = (SimpleBeanStudentInfo) kryoSerializer.unserialize(serialBytes); 79 | assertEquals(rawSimpleBean, unserializeSimpleBean); 80 | 81 | } 82 | 83 | // test kryo thread safe 84 | @Test 85 | void testKryoSerializeMultiThread() throws IOException { 86 | for (int i = 0; i < 10000; i++) { 87 | new Thread(() -> { 88 | SimpleBeanStudentInfo rawSimpleBean = new SimpleBeanStudentInfo(); 89 | byte[] serialBytes = kryoSerializer.serialize(rawSimpleBean); 90 | 91 | SimpleBeanStudentInfo unserializeSimpleBean = (SimpleBeanStudentInfo) kryoSerializer.unserialize(serialBytes); 92 | assertEquals(rawSimpleBean, unserializeSimpleBean); 93 | }).start(); 94 | } 95 | } 96 | 97 | /** 98 | * SimpleBeanSerializedFile contains serialized bytes of an default object of simpleBeanCourceInfo. KryoSerializer can 99 | * unserialize from bytes of file derectly 100 | * 101 | * @throws IOException 102 | */ 103 | @Test 104 | void testKryoUnserializeWithoutRegistryWithFile() throws IOException { 105 | SimpleBeanCourseInfo rawSimpleBean = new SimpleBeanCourseInfo(); 106 | 107 | InputStream inputStream = SerializerTestCase.class.getClass() 108 | .getResourceAsStream("/simpleBeanCourseInfoSerializedFile"); 109 | if (inputStream == null) { 110 | return; 111 | } 112 | ByteArrayOutputStream buffer = new ByteArrayOutputStream(); 113 | 114 | int nRead; 115 | byte[] data = new byte[1000]; 116 | 117 | while ((nRead = inputStream.read(data, 0, data.length)) != -1) { 118 | buffer.write(data, 0, nRead); 119 | } 120 | buffer.flush(); 121 | 122 | SimpleBeanCourseInfo unserializeSimpleBean = (SimpleBeanCourseInfo) kryoSerializer.unserialize(data); 123 | assertEquals(rawSimpleBean, unserializeSimpleBean); 124 | 125 | } 126 | 127 | @Test 128 | void testJDKSerialize() { 129 | SimpleBeanStudentInfo rawSimpleBean = new SimpleBeanStudentInfo(); 130 | 131 | for (int i = 0; i != max; ++i) { 132 | jdkSerializer.serialize(rawSimpleBean); 133 | } 134 | 135 | byte[] serialBytes = jdkSerializer.serialize(rawSimpleBean); 136 | SimpleBeanStudentInfo unserializeSimpleBean = (SimpleBeanStudentInfo) jdkSerializer.unserialize(serialBytes); 137 | 138 | for (int i = 0; i != max; ++i) { 139 | jdkSerializer.unserialize(serialBytes); 140 | } 141 | 142 | assertEquals(rawSimpleBean, unserializeSimpleBean); 143 | 144 | } 145 | 146 | @Test 147 | void testSerializeCofig() { 148 | RedisConfig redisConfig = RedisConfigurationBuilder.getInstance().parseConfiguration(); 149 | assertEquals(JDKSerializer.class, redisConfig.getSerializer().getClass()); 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /src/test/java/org/mybatis/caches/redis/SimpleBeanCourseInfo.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis; 17 | 18 | import java.io.Serializable; 19 | 20 | public class SimpleBeanCourseInfo implements Serializable { 21 | 22 | private static final long serialVersionUID = 1L; 23 | 24 | String name; 25 | int id; 26 | 27 | public SimpleBeanCourseInfo() { 28 | this.name = "Machine Learning"; 29 | this.id = 101; 30 | } 31 | 32 | public String getName() { 33 | return name; 34 | } 35 | 36 | public void setName(String name) { 37 | this.name = name; 38 | } 39 | 40 | public int getId() { 41 | return id; 42 | } 43 | 44 | public void setId(int id) { 45 | this.id = id; 46 | } 47 | 48 | @Override 49 | public String toString() { 50 | return "CourseInfo [name=" + name + ", id=" + id + "]"; 51 | } 52 | 53 | @Override 54 | public boolean equals(Object obj) { 55 | if (obj == null) { 56 | return false; 57 | } 58 | if (!obj.getClass().equals(SimpleBeanCourseInfo.class)) { 59 | return false; 60 | } 61 | return this.toString().equals(obj.toString()); 62 | } 63 | 64 | } 65 | -------------------------------------------------------------------------------- /src/test/java/org/mybatis/caches/redis/SimpleBeanStudentInfo.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2023 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis; 17 | 18 | import java.io.Serializable; 19 | import java.util.ArrayList; 20 | 21 | public class SimpleBeanStudentInfo implements Serializable { 22 | 23 | private static final long serialVersionUID = 1L; 24 | 25 | String name; 26 | int age; 27 | int grade; 28 | String sex; 29 | ArrayList courses; 30 | 31 | public SimpleBeanStudentInfo() { 32 | this.name = "Kobe Bryant"; 33 | this.age = 40; 34 | this.grade = 12; 35 | this.sex = "MALE"; 36 | this.courses = new ArrayList(); 37 | this.courses.add("English"); 38 | this.courses.add("Math"); 39 | this.courses.add("Physics"); 40 | } 41 | 42 | public String getName() { 43 | return name; 44 | } 45 | 46 | public void setName(String name) { 47 | this.name = name; 48 | } 49 | 50 | public int getAge() { 51 | return age; 52 | } 53 | 54 | public void setAge(int age) { 55 | this.age = age; 56 | } 57 | 58 | public int getGrade() { 59 | return grade; 60 | } 61 | 62 | public void setGrade(int grade) { 63 | this.grade = grade; 64 | } 65 | 66 | public String getSex() { 67 | return sex; 68 | } 69 | 70 | public void setSex(String sex) { 71 | this.sex = sex; 72 | } 73 | 74 | @Override 75 | public String toString() { 76 | return "StudentInfo [name=" + name + ", age=" + age + ", grade=" + grade + ", sex=" + sex + "]"; 77 | } 78 | 79 | @Override 80 | public boolean equals(Object obj) { 81 | if (obj == null) 82 | return false; 83 | if (!obj.getClass().equals(SimpleBeanStudentInfo.class)) 84 | return false; 85 | return this.toString().equals(obj.toString()); 86 | } 87 | 88 | } 89 | -------------------------------------------------------------------------------- /src/test/java/org/mybatis/caches/redis/sslconfig/TestHostnameVerifier.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis.sslconfig; 17 | 18 | import javax.net.ssl.HostnameVerifier; 19 | import javax.net.ssl.SSLSession; 20 | 21 | public class TestHostnameVerifier implements HostnameVerifier { 22 | @Override 23 | public boolean verify(String hostname, SSLSession session) { 24 | return false; 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /src/test/java/org/mybatis/caches/redis/sslconfig/TestSSLParameters.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis.sslconfig; 17 | 18 | import javax.net.ssl.SSLParameters; 19 | 20 | public class TestSSLParameters extends SSLParameters { 21 | } 22 | -------------------------------------------------------------------------------- /src/test/java/org/mybatis/caches/redis/sslconfig/TestSSLSocketFactory.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2015-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://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, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.caches.redis.sslconfig; 17 | 18 | import java.io.IOException; 19 | import java.net.InetAddress; 20 | import java.net.Socket; 21 | import java.net.UnknownHostException; 22 | 23 | import javax.net.ssl.SSLSocketFactory; 24 | 25 | public class TestSSLSocketFactory extends SSLSocketFactory { 26 | 27 | @Override 28 | public Socket createSocket(Socket s, String host, int port, boolean autoClose) throws IOException { 29 | return null; 30 | } 31 | 32 | @Override 33 | public String[] getDefaultCipherSuites() { 34 | return null; 35 | } 36 | 37 | @Override 38 | public String[] getSupportedCipherSuites() { 39 | return null; 40 | } 41 | 42 | @Override 43 | public Socket createSocket(String arg0, int arg1) throws IOException, UnknownHostException { 44 | return null; 45 | } 46 | 47 | @Override 48 | public Socket createSocket(InetAddress arg0, int arg1) throws IOException { 49 | return null; 50 | } 51 | 52 | @Override 53 | public Socket createSocket(String arg0, int arg1, InetAddress arg2, int arg3) 54 | throws IOException, UnknownHostException { 55 | return null; 56 | } 57 | 58 | @Override 59 | public Socket createSocket(InetAddress arg0, int arg1, InetAddress arg2, int arg3) throws IOException { 60 | return null; 61 | } 62 | 63 | } 64 | -------------------------------------------------------------------------------- /src/test/resources/redis.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015-2022 the original author or authors. 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # https://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, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | redis.host=localhost 18 | redis.port=6379 19 | redis.connectionTimeout=5000 20 | redis.soTimeout=5000 21 | redis.password= 22 | redis.database=0 23 | redis.clientName= 24 | 25 | #serializer type(kryo or jdk with jdk being default) 26 | redis.serializer=jdk 27 | 28 | #These are incorrect so comment out for now until fixed 29 | #redis.ssl= 30 | #redis.sslSocketFactory= 31 | #redis.sslParameters= 32 | #redis.hostnameVerifier= 33 | -------------------------------------------------------------------------------- /src/test/resources/simpleBeanCourseInfoSerializedFile: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mybatis/redis-cache/a5cbbb4b0c75ce599f043bf8a99603be8ee0fbc1/src/test/resources/simpleBeanCourseInfoSerializedFile -------------------------------------------------------------------------------- /src/test/resources/test1.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015-2022 the original author or authors. 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # https://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, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | redis.serializer=kryo 18 | redis.ssl=true 19 | redis.sslSocketFactory=org.mybatis.caches.redis.sslconfig.TestSSLSocketFactory 20 | redis.sslParameters=org.mybatis.caches.redis.sslconfig.TestSSLParameters 21 | redis.hostnameVerifier=org.mybatis.caches.redis.sslconfig.TestHostnameVerifier 22 | --------------------------------------------------------------------------------