JOhm 技术文档

1. 安装指南

1.1 环境要求

• Java 8 或更高版本
• Redis 数据库

1.2 下载与安装

1. 下载最新版本的 JOhm 库文件。
2. 将下载的 JOhm 库文件添加到你的 Java 项目中。
3. 确保你的项目中已经配置了 Redis 数据库的连接。

2. 项目的使用说明

2.1 基本概念

JOhm 是一个用于 Java 的对象-哈希映射库，灵感来源于 Ohm 库。它允许你将 Java 对象存储在 Redis 数据库中，而无需扩展框架基类或提供过多的配置元数据。

2.2 主要特性

• 基本属性持久化（如 String、Integer 等）
• 自动生成数字 ID
• 引用关系
• 数组、列表、集合、有序集合和映射的关系
• 索引支持
• 删除操作
• 基于属性、数组、集合和引用的搜索功能

2.3 示例代码

以下是一个简单的示例，展示了如何使用 JOhm 进行对象的创建、保存、加载和删除操作。

@Model
class User {
    @Id
    private Long id;
    @Attribute
    private String name;
    @Attribute
    @Indexed
    private int age;
    @Reference
    @Indexed
    private Country country;
    @CollectionList(of = Comment.class)
    @Indexed
    private List<Comment> comments;
    @CollectionSet(of = Item.class)
    @Indexed
    private Set<Item> purchases;
    @CollectionMap(key = Integer.class, value = Item.class)
    @Indexed
    private Map<Integer, Item> favoritePurchases;
    @CollectionSortedSet(of = Item.class, by = "price")
    @Indexed
    private Set<Item> orderedPurchases;
    @Array(of = Item.class, length = 3)
    @Indexed
    private Item[] threeLatestPurchases;
}

@Model
class Comment {
    @Id
    private Long id;
    @Attribute
    private String text;
}

@Model
class Item {
    @Id
    private Long id;
    @Attribute
    private String name;
}

// 初始化 JOhm
JedisPool jedisPool = new JedisPool(new Config(), "localhost");
JOhm.setPool(jedisPool);

// 创建并保存一个 User 对象
User someOne = new User();
someOne.setName("Someone");
someOne.setAge(30);
JOhm.save(someOne);

// 加载一个已保存的 User 对象
User storedUser = JOhm.get(User.class, 1);

// 删除一个 User 对象
JOhm.delete(User.class, 1);

// 搜索所有年龄为 30 的用户
List<User> users = JOhm.find(User.class, "age", "30");

3. 项目 API 使用文档

3.1 核心 API

• JOhm.save(Object obj): 保存对象到 Redis 数据库。
• JOhm.get(Class<?> clazz, long id): 根据 ID 加载对象。
• JOhm.delete(Class<?> clazz, long id): 根据 ID 删除对象。
• JOhm.find(Class<?> clazz, String attribute, String value): 根据属性值搜索对象。

3.2 注解

• @Model: 标记一个类为 JOhm 模型。
• @Id: 标记一个字段为对象的唯一标识符。
• @Attribute: 标记一个字段为可持久化的属性。
• @Indexed: 标记一个字段为可索引的属性，支持搜索。
• @Reference: 标记一个字段为引用关系。
• @CollectionList, @CollectionSet, @CollectionMap, @CollectionSortedSet: 标记一个字段为集合关系。
• @Array: 标记一个字段为数组。

4. 项目安装方式

4.1 手动安装

1. 下载 JOhm 的最新版本。
2. 将 JOhm 的 JAR 文件添加到你的项目依赖中。
3. 配置 Redis 数据库连接。

4.2 Maven 安装

在你的 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>com.github.xetorthio</groupId>
    <artifactId>johm</artifactId>
    <version>最新版本号</version>
</dependency>

4.3 Gradle 安装

在你的 build.gradle 文件中添加以下依赖：

implementation 'com.github.xetorthio:johm:最新版本号'

通过以上步骤，你就可以在你的项目中使用 JOhm 进行对象的持久化和操作了。