# EasyRoom

**Repository Path**: xingk/easy-room

## Basic Information

- **Project Name**: EasyRoom
- **Description**: 自动为Room生成DataBase类，封装部分常用方法到BaseDao，Dao接口只要继承BaseDao，就能方便的使用这些方法
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-09-24
- **Last Updated**: 2025-09-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# EasyRoom

#### 介绍
自动为Room生成DataBase类，封装部分常用方法到BaseDao，Dao接口只要继承BaseDao，就能方便的使用这些方法

#### 软件架构
编译时注解 + JavaPoet


#### 安装教程
```
implementation 'com.dlkw.easyroom:easyroom:1.0'
annotationProcessor 'com.dlkw.easyroom:easyroom-compiler:1.0'
```
#### 使用说明

1.  app模块gradle配置：（可不配置）, autoMigrations暂时不可用，请等待完善

    ```
    android {
        ...
    
        defaultConfig {
            ...
    
            javaCompileOptions {
                annotationProcessorOptions {
                    //roomDbClass是数据库名字，可不设置
                    //其它三个参数分别对应Room的@Database注解的version、exportSchema、autoMigrations参数
                    arguments += [
                            "roomDbClass": "com.dlkw.easyroom.sample.AppDatabase",
                            "roomDbVersion": "1",
                            "roomDbExportSchema": "true",
                          //"roomDbAutoMigrations": '[{"from":1,"to":2,"spec":"com.dlkw.easyroom.sample.DbMigration"}]'
                    ]
                }
            }
    }
     ```

2.  初始化

    ```EasyRoom.init(this, "database.db");```

3.  使用

    ```
    UserDao userDao = EasyRoom.getDao(UserDao.class);
    List<User> users = userDao.listAll();
    ```