JetCache 使用教程

JetCache 使用教程

jetcacheJetCache is a Java cache framework.项目地址:https://gitcode.com/gh_mirrors/je/jetcache

1. 项目的目录结构及介绍

JetCache 项目的目录结构如下：

jetcache/
├── docs/
├── jetcache-anno-api/
├── jetcache-anno/
├── jetcache-bom/
├── jetcache-core/
├── jetcache-parent/
├── jetcache-starter/
├── jetcache-support/
├── jetcache-test/
├── samples/
├── env/
├── .gitignore
├── .travis.yml
├── Building.txt
├── LICENSE
├── changelog.txt
├── docker-compose.yml
├── introduce_CN.md
├── pom.xml
├── readme.md

目录介绍

• docs/: 包含项目的文档文件。
• jetcache-anno-api/: 包含注解API的相关代码。
• jetcache-anno/: 包含注解处理的相关代码。
• jetcache-bom/: 包含Bill of Materials (BOM) 配置。
• jetcache-core/: 包含核心缓存功能的实现。
• jetcache-parent/: 项目的父POM文件。
• jetcache-starter/: 包含Spring Boot Starter配置。
• jetcache-support/: 包含支持类和工具类。
• jetcache-test/: 包含测试代码。
• samples/: 包含示例代码。
• env/: 包含环境配置文件。
• .gitignore: Git忽略配置文件。
• .travis.yml: Travis CI配置文件。
• Building.txt: 构建说明文件。
• LICENSE: 许可证文件。
• changelog.txt: 变更日志文件。
• docker-compose.yml: Docker Compose配置文件。
• introduce_CN.md: 中文介绍文件。
• pom.xml: 主POM文件。
• readme.md: 项目README文件。

2. 项目的启动文件介绍

JetCache 项目的启动文件通常位于 samples/ 目录下，或者在具体的示例项目中。以下是一个典型的启动类示例：

@SpringBootApplication
@EnableMethodCache(basePackages = "com.cxytiandi.jetcache")
@EnableCreateCacheAnnotation
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

启动类介绍

• @SpringBootApplication: 启用Spring Boot自动配置。
• @EnableMethodCache: 启用方法缓存功能，指定缓存包路径。
• @EnableCreateCacheAnnotation: 启用创建缓存注解。
• public static void main(String[] args): 主方法，启动Spring Boot应用。

3. 项目的配置文件介绍

JetCache 项目的配置文件通常位于 src/main/resources 目录下，以下是一个典型的配置文件示例：

jetcache:
  statIntervalMinutes: 15
  areaInCacheName: false
  local:
    default:
      type: linkedhashmap
      keyConvertor: fastjson2
      limit: 100
  remote:
    default:
      type: redis
      keyConvertor: fastjson2
      broadcastChannel: projectA
      valueEncoder: java
      valueDecoder: java
      poolConfig:
        minIdle: 5
        maxIdle: 20
        maxTotal: 50
      host: $[redis host]
      port: $[redis port]

配置文件介绍

• jetcache.statIntervalMinutes: 统计数据输出间隔，0表示不统计。
• jetcache.areaInCacheName: 是否在缓存key中加入区域前缀。
• jetcache.local.default: 本地缓存配置，类型为 linkedhashmap。
• jetcache.remote.default: 远程缓存配置，类型为 redis。
• keyConvertor: key的转换器。
• valueEncoder 和 valueDecoder: 值的编码器和解码器。
• poolConfig: 连接池配置。
• host 和 port: Redis服务器地址和端口。

以上是 JetCache 项目的

jetcacheJetCache is a Java cache framework.项目地址:https://gitcode.com/gh_mirrors/je/jetcache