Giter Site home page Giter Site logo

AutoDao

AutoDao是一个基于编译时支持DSL灵活性能良好的Android ORM框架

ORM的思考

几年前,自己开始进行Android应用程序开发的时候,老大说了一句至今印象深刻的话:没有必要不要去用ORM框架,会影响应用的性能。后来随着负责开发的应用越来越复杂,本地存储场景也越来越多,使用ORM框架的来简便工作变得有必要了,那么ORM框架能帮我们节省的工作有哪些呢?个人认为有如下几点:

  • 实体对象到数据库表之间的映射(表、列的定义等)
  • SQL的编写(创建、删除表SQL,CRUD SQL等)
  • 实体的存储和读取

上面列举的几点可能没有包含ORM的所有功能,但都是现有ORM框架的核心功能点。既然这些boil code我们不想去写,那么可不可以由工具来生成或者由通用代码来替代呢?

现在主流的ORM实现也大部分是这两个方向,通过工具来生成boil code的代表是greenDAO,通过代码(反射)来替代boil code的代表有ActiveAndroidLitePal等。一般来说通过反射会比代码生成方式性能差一点,但对外接口会灵活很多。基于这两点的对比,自己才编写了AutoDao框架,满足性能接口灵活两方面的需求。

现有的功能

AutoDao还处在快速开发阶段,现在只包含了一些核心的功能

  • 实体对象到数据库表之间的映射(表、列名字的自动生成)
  • SQL生成(建表SQL、建索引SQL等)
  • 自动生成实体DAO,主要包含CRUD方法
  • Custom Type支持,复杂数据类型到基本数据类型映射
  • 多数据库支持
  • DSL支持,CRUD仅需一行代码
  • 预编译缓存,性能提升

快速开始

注解
@Table(name = "user")
@Index(name = "id_card_vision_index", columns = {"idCard", "vision"}, unique = true)
public class User extends Model{

    @Column(name = "userName", notNULL = true)
    public String name;

    @Column(notNULL = true, defaultValue = "89900", check = "idCard>0", unique = false)
    public int idCard;
    public float vision;
    public long registTime;
    public boolean logined;
    public byte[] avatar;

    @Column(name = "addressName")
    @Mapping(name = "name")
    public List<Address> addresses;

    @Column(name = "photoId")
    public Photo photo;

    @Serializer(
            serializerCanonicalName = "com.example.autodao.DateSerializer",
            serializedTypeCanonicalName = "long"
    )
    public Date createTime;

}
生成代码

对实体类定义了注解后,需要生成相关的代码(DAO,Contract),直接使用Gradle命令行工具

./gradlew clean assembleDebug /** MAC平台 */
CRUD
插入
new Insert(injector).from(User.class).with(user).insert();
删除
new Delete(injector).from(User.class).where(UserContract.USERNAME_COLUMN+"=?", "xx").delete();
修改
new Update(injector, UserContract.USERNAME_COLUMN, UserContract.VISION_COLUMN, UserContract.IDCARD_COLUMN, UserContract.CREATETIME_COLUMN)
                .from(User.class)
                .where(UserContract.IDCARD_COLUMN+"=?", 1111)
                .with(user)
                .update();
查询
List<User> users = new Select(injector)
                .from(User.class)
                .where(UserContract.USERNAME_COLUMN + "=?", "tubb")
                .or(UserContract.IDCARD_COLUMN+"=?", 19120)
                .select();

User userObj = new Select(injector, UserContract._ID_COLUMN, UserContract.USERNAME_COLUMN, UserContract.IDCARD_COLUMN)
                .from(User.class)
                .where(UserContract.USERNAME_COLUMN + "=?", "tubb")
                .selectSingle();
Join Select
Object obj = new JoinSelect(injector, "u._id uid", "u.userName userName", "a.name addressName")
                .from(User.class, "u")
                .innerJoin(Address.class, "a")
                .on("u._id=a._id")
                .select(new JoinSelect.CursorHandler() {
                    @Override
                    public Object onHandle(Cursor cursor) {
                        List<UserAddress> userAddresses = new ArrayList<>(cursor.getCount());
                        while (cursor.moveToNext()) {
                            UserAddress userAddress = new UserAddress();
                            long userId = cursor.getLong(cursor.getColumnIndex("uid"));
                            String userName = cursor.getString(cursor.getColumnIndex("userName"));
                            String addressName = cursor.getString(cursor.getColumnIndex("addressName"));
                            userAddress.userId = userId;
                            userAddress.userName = userName;
                            userAddress.addressName = addressName;
                            userAddresses.add(userAddress);
                        }
                        cursor.close();
                        return userAddresses;
                    }
                });
List<UserAddress> userAddressList = (List<UserAddress>) obj;

NOTE

AutoDao还处在快速开发阶段,在对源码不熟悉的情况下切勿应用在正式的项目上! 非常欢迎对这个项目感兴趣的童鞋提供建议,或者直接参与进来 : )

autodao's Projects

autodao icon autodao

AutoDao是一个基于编译时,支持DSL,灵活,性能良好的Android ORM框架

crepecake icon crepecake

An compile-time aop engine like AspectJ but easier to use in android application development.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.