Ace-Cache 开源项目使用文档

Ace-Cache 开源项目使用文档

ace-cache基于spring boot上的注解缓存，自带轻量级缓存管理页面。@Cache比spring cache更轻量的缓存，支持单个缓存设置过期时间，可以根据前缀移除缓存。采用fastjson序列化与反序列化，以json串存于缓存之中。ace-cache可以快速用于日常的spring boot应用之中。项目地址:https://gitcode.com/gh_mirrors/ac/ace-cache

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

Ace-Cache 项目的目录结构如下：

ace-cache/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── wxiaoqi/
│   │   │           └── ace/
│   │   │               └── cache/
│   │   │                   ├── config/
│   │   │                   ├── controller/
│   │   │                   ├── entity/
│   │   │                   ├── service/
│   │   │                   └── AceCacheApplication.java
│   │   └── resources/
│   │       ├── application.yml
│   │       └── bootstrap.yml
│   └── test/
│       └── java/
│           └── com/
│               └── wxiaoqi/
│                   └── ace/
│                       └── cache/
│                           └── AceCacheApplicationTests.java
├── pom.xml
└── README.md

目录结构介绍

• src/main/java/com/wxiaoqi/ace/cache/: 包含项目的核心代码。
  • config/: 存放配置类，如缓存配置。
  • controller/: 存放控制器类，处理HTTP请求。
  • entity/: 存放实体类，定义数据模型。
  • service/: 存放服务类，处理业务逻辑。
  • AceCacheApplication.java: 项目的启动类。
• src/main/resources/: 存放项目的配置文件和静态资源。
  • application.yml: 主配置文件。
  • bootstrap.yml: 引导配置文件。
• src/test/java/com/wxiaoqi/ace/cache/: 存放测试类。
  • AceCacheApplicationTests.java: 项目的测试类。
• pom.xml: Maven 项目配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

AceCacheApplication.java

AceCacheApplication.java 是 Ace-Cache 项目的启动类，位于 src/main/java/com/wxiaoqi/ace/cache/ 目录下。该类主要包含以下内容：

package com.wxiaoqi.ace.cache;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class AceCacheApplication {

    public static void main(String[] args) {
        SpringApplication.run(AceCacheApplication.class, args);
    }
}

启动类介绍

• @SpringBootApplication: 这是一个组合注解，包含了 @Configuration, @EnableAutoConfiguration, 和 @ComponentScan 注解，用于简化 Spring Boot 应用的配置。
• main 方法: 项目的入口方法，通过 SpringApplication.run 方法启动 Spring Boot 应用。

3. 项目的配置文件介绍

application.yml

application.yml 是 Ace-Cache 项目的主配置文件，位于 src/main/resources/ 目录下。该文件包含了应用的各种配置，如服务器端口、数据源配置、缓存配置等。

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/ace_cache
    username: root
    password: root

  cache:
    type: redis
    redis:
      host: localhost
      port: 6379

配置文件介绍

• server.port: 指定应用的运行端口。
• spring.datasource: 配置数据源，包括数据库的 URL、用户名和密码。
• spring.cache: 配置缓存类型和 Redis 的连接信息。

bootstrap.yml

bootstrap.yml 是 Ace-Cache 项目的引导配置文件，位于 src/main/resources/ 目录下。该文件通常用于配置一些在应用启动前需要加载的配置，如配置中心的相关配置。

spring:
  application:
    name: ace-cache

引导配置文件介绍

• spring.application.name:

ace-cache基于spring boot上的注解缓存，自带轻量级缓存管理页面。@Cache比spring cache更轻量的缓存，支持单个缓存设置过期时间，可以根据前缀移除缓存。采用fastjson序列化与反序列化，以json串存于缓存之中。ace-cache可以快速用于日常的spring boot应用之中。项目地址:https://gitcode.com/gh_mirrors/ac/ace-cache