# SpEasy

**Repository Path**: zfox/SpEasy

## Basic Information

- **Project Name**: SpEasy
- **Description**: 安卓存储工具SharedPreferences的orm封装,通过对对象的操作,完成数据的读取和存储,简单好用,存储和读取只需要一句话调用!
- **Primary Language**: Android
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2018-07-27
- **Last Updated**: 2022-06-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SpEasy

#### 项目介绍
安卓存储工具SharedPreferences的orm封装,通过对对象的操作,完成数据的读取和存储,简单好用,存储和读取只需要一句话调用!

#### 软件架构
SharedPreferencesUtil:简单封装的工具类,可以直接使用,但是每次操作都需要自己处理异常;
SharedPreferencesTrait:封装对象,所有模型类文件都要继承自这个类才有效;
SpEasy:最终封装结果,在Application中初始化之后,可以做到一行代码存储,一行代码读取数据,通过操作对象,完成数据的操作;


#### 使用教程

1. 下载speasy文件夹中的三个文件,copy到你的项目中;
2. 在Application中进行初始化,在初始化时如果不指定全局的异常处理,就会默认调用一个空的异常处理;
    `SpEasy.init(this,this);或者SpEasy.init(this);`
![初始化示例图](https://images.gitee.com/uploads/images/2018/0727/111413_232596e5_1883971.png "效果图1.png")
3. 书写一个模型类,并且继承自SharedPreferencesTrait类,赋予其参数的get和set方法;
![模型类](https://images.gitee.com/uploads/images/2018/0727/111703_73b5fd36_1883971.png "效果图2.png")
4. 通过操作类来存储和删除数据
![存储数据](https://images.gitee.com/uploads/images/2018/0727/111809_d9b430dc_1883971.png "效果图3.png")
![查询数据](https://images.gitee.com/uploads/images/2018/0727/111859_d06f0eca_1883971.png "效果图4.png")
5. 如果需要处理结果,可以使用封装的commit提交的方法putxxx(),这类方法带有boolean的返回值,表示是否存储成功;

#### 注意事项

1. 进行数据存储和查询之前必须进行初始化操作,不然会报空指针;
2. 目前对Set<String>没有支持,后面再加,支持其他基本类型{String,int,long,boolean,float};
3. 后面预计增加Config配置类,把一些写死的东西规整到配置类信息中;

 **2.0版本** 
SpEasy是一个基于SharedPreferences封装的一个面向对象的数据存储类,用法功能和其稳定行在1.0版本就经过了测试,2.0版本增加了通过注解注入参数;

SpEasy1.0博客地址:https://blog.csdn.net/qq_36676433

码云地址:https://gitee.com/zfox/SpEasy

使用方法:

1.在Application中调用SpEasy的初始化方法,便可以启用SpEasy1.0版本;

2.如果要使用注解,需要在你的BaseActivity和BaseFragment中增加注解扫描.

3.增加注解初始化方法和标记销毁方法,初始化方法要在create中进行,并且要在类中参数初始化之前调用;销毁标记方法在页面destory方法中进行;

//初始化SpEasy自动注入
Sp.inSet(this.getClass(),this);
//页面销毁时取消标记
Sp.destroy(this.getClass(),this);
4.初始化成功后就可以进行使用了:

//使用注解注入参数 
@SpGet
public UserInfo info;
 
//使用
info.getUsername()
 
//注意,使用的UserInfo类一定要遵循SpEasy1.0的原则,要继承自SharedPreferencesTrait类才可以
//修改参数并保存
info.setUsername(phone);
info.setPassword(password);
info.setSelfLogin(checked.isChecked());
Sp.inSave();
 

#### 联系我

1. 码云:@zFox 
2. GitHub:jy231613
3. CSDN:[https://blog.csdn.net/qq_36676433](https://blog.csdn.net/qq_36676433)
4. wechat:jy271613
5. QQ:2757525207