Nepxion Aquarius 开源项目安装与使用指南

Nepxion Aquarius 开源项目安装与使用指南

Aquarius 🔱 Nepxion Aquarius is a list of distribution components based on Redis + Zookeeper with Nepxion Matrix AOP framework, including distribution lock, cache, id generator, limitation 分布式锁、缓存、全局唯一主键、限流 项目地址: https://gitcode.com/gh_mirrors/aq/Aquarius

Nepxion Aquarius 是一款强大的分布式应用组件集合，基于Redis和Zookeeper，利用Nepxion Matrix AOP框架实现，旨在简化分布式环境下的锁管理、缓存处理、ID生成和流量限制等常见任务。本教程将引导您了解其核心组成部分，并指导您如何快速地集成到您的应用程序中。

1. 项目目录结构及介绍

Nepxion Aquarius 的项目结构精心设计以支持模块化开发。以下是一些关键目录的概述：

- Aquarius/
  ├── aquarius-cache-aop            // 缓存AOP增强模块
  ├── aquarius-cache-redis          // Redis缓存模块
  ├── aquarius-cache-starter        // 缓存启动器，用于快速接入
  ├── aquarius-common-redis         // Redis通用工具类
  ├── aquarius-common-zookeeper     // Zookeeper通用工具类
  ├── aquarius-common               // 核心公共代码
  ├── aquarius-id-generator-local   // 本地ID生成器
  ├── aquarius-id-generator-redis   // Redis为基础的ID生成模块
  ├── aquarius-id-generator-starter // ID生成器启动器
  ├── aquarius-limit-aop           // 流量限制AOP增强模块
  ├── aquarius-limit-local          // 本地流量限制
  ├── aquarius-limit-redis          // Redis为基础的流量限制
  ├── aquarius-limit-starter        // 流量限制启动器
  ├── aquarius-lock-aop             // 分布式锁的AOP增强
  ├── aquarius-lock-local           // 本地锁
  ├── aquarius-lock-redis           // Redis为基础的分布式锁
  ├── aquarius-lock-starter         // 分布式锁启动器
  ├── aquarius-lock-zookeeper       // Zookeeper为基础的分布式锁
  ├── aquarius-spring-boot-example  // Spring Boot示例应用
  ├── aquarius-spring-cloud-example // Spring Cloud示例应用
  ├── ... (其他配置文件、许可证、README等)

每个模块负责特定的功能，比如cache模块涉及缓存处理，id-generator模块专注于生成全局唯一标识符，而lock模块提供了分布式锁解决方案。

2. 项目的启动文件介绍

Nepxion Aquarius 的核心在于它的模块集成到实际的应用程序中。对于快速入门，您可以查看aquarius-spring-boot-example或者aquarius-spring-cloud-example。这些示例通常含有src/main/resources下的application.properties或application.yml作为配置中心，以及src/main/java中的启动类（如MyApplication.java）。

示例启动类（简化的例子）

package com.nepxion.aquarius.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import com.nepxion.aquarius.lock.annotation.EnableLock;
import com.nepxion.aquarius.cache.annotation.EnableCache;

@SpringBootApplication
@EnableLock
@EnableCache
public class StarterApplication {
    public static void main(String[] args) {
        SpringApplication.run(StarterApplication.class, args);
    }
}

3. 项目的配置文件介绍

配置文件通常是项目的核心，决定着组件的行为。在Aquarius中，配置位于application.properties或application.yml中。这里简述几个关键配置点：

# 分布式锁配置示例
aq_lock.zk.address=127.0.0.1:2181
aq_lock.redis.sentinel.master=myMaster
aq_lock.redis.sentinel.nodes=127.0.0.1:26379,127.0.0.1:26380

# 缓存配置示例
aq_cache.redis.cluster.nodes=127.0.0.1:6379

# ID生成器配置
aq_idgenerator.redis.key.prefix=id_generator_

配置覆盖了连接信息（如Redis、Zookeeper）、特性开关以及其他定制化参数。确保根据您的实际部署调整这些配置。

---

通过以上概览，您现在应该有了对Nepxion Aquarius的基本认识，包括其目录结构、启动流程以及配置要点。为了深入使用，请参照项目中的详细文档和示例代码进行学习和实践。

Aquarius 🔱 Nepxion Aquarius is a list of distribution components based on Redis + Zookeeper with Nepxion Matrix AOP framework, including distribution lock, cache, id generator, limitation 分布式锁、缓存、全局唯一主键、限流 项目地址: https://gitcode.com/gh_mirrors/aq/Aquarius