ActiveAndroid ile ORM

15 Ekim 2013
Android JAVA
No Comments

Android kullanırken, Java EE’de olupda Android’tede olsa dediğim özelliklerden bir diğeri de ORM (Object Relational Mapping). Andorid için bu işi yapan kütüphaneler mevcut. ORMLite, greenDAO ve ActiveAndroid bunlardan bir kaçı. Ben denediklerim içinde en çok ActiveAndroid’i beğendiğimden ve kendime en yakın onu bulduğum. Bu sebepten bu yazıda ActiveAndroid kullanarak, Andorid uygulamalarınıza nasıl ORM’i entegre edeceğinizi anlatmaya çalışacağım.

Hazırlık

Öncelikle şunu belirteyim, ActiveAndroid kaynak kodları güzel yazılmış ve güzel bir proje yapısında bulunmakta. Maven kullanılarak yönetilmiş. Fakat ne yazık ki ben hiçbir maven kod deposunda JAR haline rastlayamadım. Bu sebepten Github üzerinden kodu indirip kendinizin derlemesi gerekiyor. Bunu yaptıktan sonra ister maven projesi olarak kullanın ister porjenizin libs klasörüne ekleyin bu size kalmış.

Kütüphane

Projeyi bu linke tıklayarak ZIP formatında indirebilirsiniz.
Projenizi ZIP dosyasından çıkarıp, pom.xml dosyasının olduğu dizine geliyoruz. Burada “mvn clean install” komutunu çalıştırdığınızda, oluşan JAR dosyası hem lokal maven deposuna yüklenecek hemde target klasörü altından erişilebilir olacak.
“mvn clean install” komutunun düzgün çalışabilmesi için sistem değişkenlerinizde ANDORID_HOME değişkeninin tanımlı olması gerekiyor.

Proje

Ben örneğimde basit bir Andorid uygulaması kullanacağım. Projeyi oluşturduktan sonra yukarıdaki adımlarla oluşturduğumuz JAR dosyasını libs klasörünün altına atıp kullanacağız.

Eclipse üzerinden Android Application Project yaratıyoruz. Yaratırken aşağıdaki değerleri kullanıyorum.

Application Name: ORMTutorial
Project Name: ORMTutorial
Package Name: com.bahadirakin.orm
Minimum Required SDK: API 8
Target SDK: API 18
Compile With: API 18
Theme: None

Daha sonra proje oluştuktan sonra oluşturduğumuz activeandroid-<version>.jar dosyasını libs klasörünün altına kopyalıyoruz. Böylelikle projemiz hazır hale geliyor. Burdan sorna ayarlarımızı yapıp, nesnlerimizi veribanına kaydetmeye başlayacağız. Fakat tek bir noktaya odaklanmak için arayüzle ilgili bişeyler yapmayacağım. Sadece Toast kullanarak verileri ekrana yazdıracağım.

Ayarların Yapılması

Aslında lokalde bir veritabanı oluşturulup o veritabanı kullanılacağından yapılacak çok fazla ayarımız yok. Sadece yapmamız gerekenler şu şekilde;

Uygulama başlatıldığında veritabanı bağlantılarını açmak.
Uygulama sonlanırken ise bu bağlantıları kapatmak.
Veritabanı adının ve versiyonunun belirlenmesi.

Uygulama başlarken ve kapanırken işlemler yapacağımızdan kendi Android Application sınıfımızı yaratmamız gerekiyor. Bunun için öncelikle sınıfımızı oluşturacağız. Ardından AndoridManifest.xml dosyası içerisinde Application sınıfımızı göstereceğiz.

CustomApplication.java

package com.bahadirakin.orm;

import com.activeandroid.ActiveAndroid;

import android.app.Application;

public class CustomApplication extends Application {

	@Override
	public void onCreate() {
		super.onCreate();
		ActiveAndroid.initialize(this);
	}

	@Override
	public void onTerminate() {
		super.onTerminate();
		ActiveAndroid.dispose();
	}

}

package com.bahadirakin.orm;

import com.activeandroid.ActiveAndroid;

import android.app.Application;

public class CustomApplication extends Application {

@Override

public void onCreate() {

super.onCreate();

ActiveAndroid.initialize(this);

}

@Override

public void onTerminate() {

super.onTerminate();

ActiveAndroid.dispose();

}

Böylelikle kendi Application sınıfımızı yaratmış olduk. Burdan sonra bu sınıfımızı AndoridManifest.xml dosyası içerisinde belirtmeliyiz ki uygulamamız bizim sınıfımız üzerinden başlasın.

AndroidManifest.xml

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.bahadirakin.orm"
    android:versionCode="1"
    android:versionName="1.0" >

    <uses-sdk
        android:minSdkVersion="8"
        android:targetSdkVersion="18" />

    <application
        android:name="com.bahadirakin.orm.CustomApplication"
        android:allowBackup="true"
        android:icon="@drawable/ic_launcher"
        android:label="@string/app_name"
        android:theme="@style/AppTheme" >

        <meta-data android:name="AA_DB_NAME" android:value="Tutorial.db"></meta-data>
        <meta-data android:name="AA_DB_VERSION" android:value="1"></meta-data>

        <activity
            android:name="com.bahadirakin.orm.MainActivity"
            android:label="@string/app_name" >
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

<?xml version="1.0" encoding="utf-8"?>

<manifest xmlns:android="http://schemas.android.com/apk/res/android"

package="com.bahadirakin.orm"

android:versionCode="1"

android:versionName="1.0" >

<uses-sdk

android:minSdkVersion="8"

android:targetSdkVersion="18" />

<application

android:name="com.bahadirakin.orm.CustomApplication"

android:allowBackup="true"

android:icon="@drawable/ic_launcher"

android:label="@string/app_name"

android:theme="@style/AppTheme" >

<activity

android:name="com.bahadirakin.orm.MainActivity"

android:label="@string/app_name" >

<intent-filter>

</intent-filter>

</activity>

</application>

</manifest>

CustomApplication sınıfımızı verirken aynı zamanda veritabanı adını ve veritabanı versiyonu değerlerinide belirttik. Bu iki değer isteğe bağlı ayarlanıyor olsa da ben veritabanı adının verilmesinden yanayım. Versiyon ise ana verilerinizin kayıtlı olduğu SQL dosyalarını içe aktarmak için kullanılıyor. Örneğin kullanıcı listenizin uygulama yüklendiğinde ayarlı olmasını istiyorsanız bir SQL dosyası kullanarak yüklenmesini sağlayabilirsiniz. Bu biraz daha ayrıntı bir konu olduğundan daha fazla değinmeyeceğim ama merak ediyorsanız bu tutorial‘ı inceleyebilirsiniz.

Modeller ve CRUD

Eğer daha önce Hibernate gibi bir araçla çalıştıysanız modellerin oluşturulmasına biraz aşinasınızdır. Fakat android kullandığımızdan ve runtime sırasında PROXY’lemek maliyetli olacağından alıştığımızın biraz dışına çıkıyoruz. Sadece Annotation ile modellerimizi işaretlemenin yanında bir de Model sınıfından türetmemiz gerekiyor.

Model sınıfı aslında nesnemizi aynı zamanda kendi DAO(Data Access Object)’su haline getiriyor. Bu benim içime sinmese de hemen hemen tüm Android tabanlı ORM araçları bu şekilde çalışıyor. Basit olması açısından güzel fakat OOP prensipleri açısından felaket gibi görünsede kullanmaya devam ediyorum.

Bir diğer içime sinmeyen kısım ise ID alanlarının otomatik olarak gelmesi. Yani Model sınıfından türettiğinizde otomatik olarak size AutoIncrement bir ID atanmış oluyor. Bu kontrolü yitirmekte hoşuma gitmese de hemen hemen tüm Entity’lerinde AutoIncrement id kullandığım için çok umursamıyorum.

Şimdi örnek bir Book ve Author sınıfı yaratalım. Çoğu örnekte kullanılsa da biz biraz daha basit halini kullanacağız. Her kitabın bir yazarı olduğunu varsayıp, 1-n’lik bir ilişki gibi yaklaşacağız.

Book.java

package com.bahadirakin.orm;

import com.activeandroid.Model;
import com.activeandroid.annotation.Column;
import com.activeandroid.annotation.Table;

@Table(name = "books")
public class Book extends Model {

	@Column(name = "name")
	private String name;

	@Column(name = "author")
	private Author author;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public Author getAuthor() {
		return author;
	}

	public void setAuthor(Author author) {
		this.author = author;
	}

}

package com.bahadirakin.orm;

import com.activeandroid.Model;

import com.activeandroid.annotation.Column;

import com.activeandroid.annotation.Table;

@Table(name = "books")

public class Book extends Model {

@Column(name = "name")

private String name;

@Column(name = "author")

private Author author;

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

public Author getAuthor() {

return author;

}

public void setAuthor(Author author) {

this.author = author;

}

Author.java

package com.bahadirakin.orm;

import java.util.List;

import com.activeandroid.Model;
import com.activeandroid.annotation.Column;
import com.activeandroid.annotation.Table;

@Table(name = "authors")
public class Author extends Model {

	@Column(name = "name")
	private String name;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public List<Book> getBooks(){
		return this.getMany(Book.class, "author");
	}
}

package com.bahadirakin.orm;

import java.util.List;

import com.activeandroid.Model;

import com.activeandroid.annotation.Column;

import com.activeandroid.annotation.Table;

@Table(name = "authors")

public class Author extends Model {

@Column(name = "name")

private String name;

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

public List<Book> getBooks(){

return this.getMany(Book.class, "author");

}

Burada ilişkinin nasıl sağlandığına dikkat etmenizi istiyorum. Andorid içerisinde bir PROXY mekanizması kurulmadığından LAZY Loading gibi özellikler kullanılamıyor. Bu sebepten doğruca “Criteria” yazılmış gibi davranılıyor.

Create

Bunları yaptıktan sonra basit bir create yapılmak istenildiğinde uygulamanın başında aşağıdaki kod parçası kullanılabilir. Ben bu kod parçasını MainActivity’nin başında kullanacağım.

MainActivity.java

package com.bahadirakin.orm;

import android.os.Bundle;
import android.app.Activity;
import android.view.Menu;
import android.widget.Toast;

public class MainActivity extends Activity {

	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);

		// Create
		Author author = new Author();
		author.setName("Bahadır AKIN");
		author.save();

		Toast.makeText(this, "Author saved....Id: "+ author.getId(), Toast.LENGTH_LONG).show();
	}
}

package com.bahadirakin.orm;

import android.os.Bundle;

import android.app.Activity;

import android.view.Menu;

import android.widget.Toast;

public class MainActivity extends Activity {

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

// Create

Author author = new Author();

author.setName("Bahadır AKIN");

author.save();

Toast.makeText(this, "Author saved....Id: "+ author.getId(), Toast.LENGTH_LONG).show();

}

Bu şekilde uygulamayı çalıştırdığımızda ekranda “Author saved….Id: 1 ” yazısını yazması gerekiyor. ID’lerin otomatik olarak eklendiğini ve AutoIncrement olduklarını daha önce belirtmiştim.

Read

Şimdi kodumuzu tekrar çalıştırıp bir read işlemi yapalım. Hatta bu sefer okuduğumu Author değerini bir Book nesnesine atayıp onu veritabanına kayıt edelim.

MainActivity.java

package com.bahadirakin.orm;

import android.app.Activity;
import android.os.Bundle;
import android.widget.Toast;

public class MainActivity extends Activity {

	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);

		// Read
		Author author = Author.load(Author.class, 1);
		Book book = new Book();
		book.setName("Test Book");
		book.setAuthor(author);
		book.save();

		Toast.makeText(this, "Book saved....Id: "+ book.getId() + " And Auhtor: " + author.getName(), Toast.LENGTH_LONG).show();
	}

}

package com.bahadirakin.orm;

import android.app.Activity;

import android.os.Bundle;

import android.widget.Toast;

public class MainActivity extends Activity {

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

// Read

Author author = Author.load(Author.class, 1);

Book book = new Book();

book.setName("Test Book");

book.setAuthor(author);

book.save();

Toast.makeText(this, "Book saved....Id: "+ book.getId() + " And Auhtor: " + author.getName(), Toast.LENGTH_LONG).show();

}

Bu sefer kodumuzu çalıştırdığımızda “Book saved…Id: 1 And Author: Bahadır AKIN” mesajı gözükecek.

Update

Şimdi ise son kayıt ettiğimiz 1 numaralı Book sınıfını alalım ve kitabın ismini Test Book 2 olarak değiştirelim. Sonra da veritabanını güncelleyelim.

MainActivity.java

package com.bahadirakin.orm;

import android.app.Activity;
import android.os.Bundle;
import android.widget.Toast;

public class MainActivity extends Activity {

	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);

		//Update
		Book book = Book.load(Book.class, 1);
		book.setName("Test Book 2");
		book.save();

		Toast.makeText(this, "Book updated....Id: "+ book.getId() + " And Name: " + book.getName(), Toast.LENGTH_LONG).show();
	}

}

package com.bahadirakin.orm;

import android.app.Activity;

import android.os.Bundle;

import android.widget.Toast;

public class MainActivity extends Activity {

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

//Update

Book book = Book.load(Book.class, 1);

book.setName("Test Book 2");

book.save();

Toast.makeText(this, "Book updated....Id: "+ book.getId() + " And Name: " + book.getName(), Toast.LENGTH_LONG).show();

}

Kodumuzu bu şekilde çalıştırdığımızda da bu sefer “Book updated…. Id: 1 and Name: Test Book 2 ” yazısını göreceğiz.

Delete

Son olarak Delete işlemini yapıp CRUD işlemlerini bitiyoruz. Delete işlemi sırasında Book nesnsini sileceğiz. Eğer Book nesnesini değilde Author nesnesini silmeye kalkarsak Exception ile karşılaşırız.

package com.bahadirakin.orm;

import android.app.Activity;
import android.os.Bundle;
import android.widget.Toast;

public class MainActivity extends Activity {

	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);

		// Delete
		Book.delete(Book.class, 1);
		Book book= Book.load(Book.class, 1);

		Toast.makeText(this, "Book is null? = " + (book == null), Toast.LENGTH_LONG).show();
	}

}

package com.bahadirakin.orm;

import android.app.Activity;

import android.os.Bundle;

import android.widget.Toast;

public class MainActivity extends Activity {

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

// Delete

Book.delete(Book.class, 1);

Book book= Book.load(Book.class, 1);

Toast.makeText(this, "Book is null? = " + (book == null), Toast.LENGTH_LONG).show();

}

Sorgular

Çoğu ORM aracı, ister Java ister Android aracı, sorgular için kendi yapılarını sunmuşlardı. JPA için bu JQL olmuştur, Hibernate için Criteria API, Example yapıları ya da HQL olmuştur. ActiveAndroid’te bu araçların izinden giderek kendi sorgu methodunu geliştirmiş. Burada her büyük sorgu için kendi sınıfından oluşturuyoruz.

SELECT

Select sorguları için Select nesnesi kullanılıyor. Burdan sonra Criteria API gibi sorgunuzu oluşturmaya başlıyorsunuz.

package com.bahadirakin.orm;

import java.util.List;

import com.activeandroid.query.Select;

import android.app.Activity;
import android.os.Bundle;
import android.widget.Toast;

public class MainActivity extends Activity {

	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);

		// Select
		final List<Author> allAuthors = new Select().all().from(Author.class).execute();
		final List<Author> authors = new Select().from(Author.class).where("name = ?", "Bahadır AKIN").execute();

		Toast.makeText(this, "AllAuthors Size: " + allAuthors.size() + " Authros size: " + authors.size(), Toast.LENGTH_LONG).show();
	}

}

package com.bahadirakin.orm;

import java.util.List;

import com.activeandroid.query.Select;

import android.app.Activity;

import android.os.Bundle;

import android.widget.Toast;

public class MainActivity extends Activity {

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

// Select

final List<Author> allAuthors = new Select().all().from(Author.class).execute();

final List<Author> authors = new Select().from(Author.class).where("name = ?", "Bahadır AKIN").execute();

Toast.makeText(this, "AllAuthors Size: " + allAuthors.size() + " Authros size: " + authors.size(), Toast.LENGTH_LONG).show();

}

Burada iki select sorgusu örneği var. İlk sorgu tüm Author nesnelerini getirirken ikinci sorgu sadece adı “Bahadır AKIN” olan nesneleri getirmekte. Bu sorguları istediğiniz gibi uzatabilirsiniz. Tamamen size kalmış.

Delete

Yapabileceğiniz diğer büyük sorgulama işlemi DELETE. Bu da Select kısmında olduğu gibi Delete nesnesi üzerinden yapılıyor.

package com.bahadirakin.orm;

import java.util.List;

import com.activeandroid.query.Delete;
import com.activeandroid.query.Select;

import android.app.Activity;
import android.os.Bundle;
import android.widget.Toast;

public class MainActivity extends Activity {

	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);

		// Delete
		new Delete().from(Author.class).where("name = ?", "Bahadır AKIN").execute();
	}

}

package com.bahadirakin.orm;

import java.util.List;

import com.activeandroid.query.Delete;

import com.activeandroid.query.Select;

import android.app.Activity;

import android.os.Bundle;

import android.widget.Toast;

public class MainActivity extends Activity {

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

// Delete

new Delete().from(Author.class).where("name = ?", "Bahadır AKIN").execute();

}

Son

Her ne kadar Model ve DAO’ların birleşmiş olması ilgimi çekmese de ve ID’leri otomatik kendi üretiyorda olsa gayet kullanışlı ve basit şekilde ORM işlevini görüyor.