2 Star 3 Fork 0

JustryDeng / ext-spring-cache

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

ext-spring-cache扩展@Cacheable缓存注解

介绍

ext-spring-cache的 @ExtCacheable 是对spring的 @Cacheable 的扩展, @ExtCacheable 功能更丰富、用起来更舒心

前置条件

  • spring-boot
  • redis
  • jdk8+

功能特性

  1. @ExtCacheable支持指定RedisTemplate操作缓存(对比:@Cacheable不支持指定RedisTemplate)

  2. @ExtCacheable支持对具体的key设置过期时间(对比:@Cacheable只支持对命名空间级别设置过期时间)

  3. @ExtCacheable支持redis缓存、支持caffeine缓存、支持多级缓存(对比:@Cacheable不全支持)

  4. @ExtCacheable对@Cacheable保持兼容

  5. 支持再扩展ExtRedisCacheManager,需实现com.ideaaedi.extspringcache.custom.ExtRedisCacheManagerCustomizer并注册进spring容器

  6. 为ExtCacheable指定序列化器,需实现com.ideaaedi.extspringcache.custom.ExtRedisSerializerCustomizer并注册进spring容器

    ExtCacheable与Cacheable的序列化器相互独立。如果你使用@ExtCacheable的同时还使用到了@Cacheable,那么你还需要为@Cacheable也指定序列化器(,否则@Cacheable还是会用默认的序列化器)

  7. ...

可用版本

其余版本存在已知bug,请使用下述版本

  • 1.5.12.RELEASE.DELTA

  • 2.0.0.RELEASE.GAMMA

  • 2.1.0.RELEASE.DELTA

  • 2.2.0.RELEASE.GAMMA

  • 2.3.4.RELEASE.DELTA

  • 2.6.13.ALPHA

    注:支持jdk11+

  • 2.6.13.ALPHA

    注:支持jdk8+

  • 2.6.13.GAMMA

    注:支持jdk8+

  • 2.6.13.DELTA

    注:支持jdk8+

相关配置项

提示:可详见com.ideaaedi.extspringcache.constant.ExtCacheConfigPlaceholder

配置项 默认值 说明 since
ext.spring.cache.print-banner true 控制是否打印ext-spring-cache banner 1.5.12.RELEASE.DELTA
ext.spring.cache.redis-caffeine.caffeine-as-first-cache true 是否以caffeine作为一级缓存
true caffeine作为一级缓存,redis作为二级缓存
false redis作为一级缓存,caffeine作为二级缓存
1.5.12.RELEASE.DELTA
ext.spring.cache.redis-caffeine.value-back-fill true (若一级缓存没数据,二级缓存有数据), 是否回填二级缓存的数据至一级缓存 1.5.12.RELEASE.DELTA
ext.spring.cache.use-default-cache-manager-if-miss true 当没有ext管理器可以被总管理器ExtCacheManager管理时,管理器ExtCacheManager是否管理默认的CacheManager 1.5.12.RELEASE.DELTA
ext.spring.cache.redis.response-spring-context true true 默认对spring-context中的配置作出响应。 即:在spring-context中若存在相应配置或相关bean,那么会影响所有的Redis。此时,可通过在使用@Redis注解时,显示的指定相关配置来覆盖 spring-context中的配置
false 默认不对spring-context中的配置作出响应。即:不管spring-context是否存在相应配置或相关bean,都不会影响Redis。此时,在使用@Redis注解时,显示的指定相关配置依然有效
1.5.12.RELEASE.DELTA
ext.spring.cache.caffeine.response-spring-context true true 默认对spring-context中的配置作出响应。 即:在spring-context中若存在相应配置或相关bean,那么会影响所有的Caffeine。此时,可通过在使用@Caffeine注解时,显示的指定相关配置来覆盖 spring-context中的配置
false 默认不对spring-context中的配置作出响应。即:不管spring-context是否存在相应配置或相关bean,都不会影响Caffeine。此时,在使用@Caffeine注解时,显示的指定相关配置依然有效
1.5.12.RELEASE.DELTA
ext.spring.cache.redis-caffeine.response-spring-context true true 默认对spring-context中的配置作出响应。 即:在spring-context中若存在相应配置或相关bean,那么会影响所有的Redis、Caffeine。此时,可通过在使用@Redis、@Caffeine注解时,显示的指定相关配置来覆盖 spring-context中的配置
false 默认不对spring-context中的配置作出响应。即:不管spring-context是否存在相应配置或相关bean,都不会影响Redis、Caffeine。此时,在使用@Redis、@Caffeine注解时,显示的指定相关配置依然有效
1.5.12.RELEASE.DELTA
…… …… ……

使用说明

  • 第一步:引入依赖

    <dependency>
        <groupId>com.idea-aedi</groupId>
        <artifactId>ext-spring-cache</artifactId>
        <!-- <version>1.5.12.RELEASE.DELTA</version> -->
        <!-- <version>2.0.0.RELEASE.GAMMA</version> -->
        <!-- <version>2.1.0.RELEASE.DELTA</version> -->
        <!-- <version>2.2.0.RELEASE.GAMMA</version> -->
        <!-- <version>2.3.4.RELEASE.DELTA</version> -->
        <!-- <version>2.6.13.DELTA</version> -->
        <version>{选择与spring-boot版本号相近的版本}</version>
    </dependency>
  • 第二步:使用@EnableExtCache注解启用ext-spring-cache功能

    import com.ideaaedi.extspringcache.EnableExtCache;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @EnableExtCache
    @SpringBootApplication
    public class AppApplication {
        
        public static void main(String[] args) {
            SpringApplication.run(AppApplication.class, args);
        }
    }
  • 第三步:使用@ExtCacheable注解即可

    • 示例一

      @GetMapping("/demo")
      @ExtCacheable(
              cacheNames = "cache-demo", key = "'jd' + #param",
              caffeine = @Caffeine(expireTime = 300, maximumSize = 3, expireStrategy = CaffeineExpireStrategyEnum.EXPIRE_AFTER_ACCESS)
      )
      public Object two(String param) {
          System.err.println("进two了\t" + param);
          return param + ThreadLocalRandom.current().nextInt(100);
      }
    • 示例二

      @GetMapping("/demo")
      @ExtCacheable(cacheNames = "cache-demo", key = "'jd' + #param",
                    redis = @Redis(useRedisTemplate = "redisTemplate",
                                   expireTime = 100,
                                   timeUnit = ChronoUnit.MINUTES,
                                   expireStrategy = RedisExpireStrategyEnum.AUTO
                    )
      )
      public Object two(String param) {
          System.err.println("进two了\t" + param);
          return param + ThreadLocalRandom.current().nextInt(100);
      }
    • 示例三

      @GetMapping("/demo")
      @ExtCacheable(
              cacheNames = "cache-demo", key = "'jd' + #param",
              redis = @Redis(useRedisTemplate = "redisTemplate", expireTime = 600),
              caffeine = @Caffeine(expireTime = 300, maximumSize = 3)
      )
      public Object two(String param) {
          System.err.println("进two了\t" + param);
          return param + ThreadLocalRandom.current().nextInt(100);
      }
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

对spring-cache注解@Cacheable进行扩展,欢迎mark 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/JustryDeng/ext-spring-cache.git
git@gitee.com:JustryDeng/ext-spring-cache.git
JustryDeng
ext-spring-cache
ext-spring-cache
master

搜索帮助