Javaな部屋

目次

JavaSE5でのアノテーションの使い方

アノテーション作り方

public @interface Marker {}

public @interface SingleValue {
	String value() default "nothing";
}

public @interface MultiValue {
	String[] values();
	int amount();
}

アノテーションの付与方法

@Marker //クラス
class AnnotationSample{
	@Marker
	AnnotationSample(){} //コンストラクタ
	
	@Marker
	String word; //フィールド
	
	@Marker
	void doSomething(){} //メソッド
}

class AnnotationUser {	
	@SingleValue("Hello")
	public void doSingleValue(){}
	
	@MultiValue(values={"Japan","Chiba"},amount=100)
	public AnnotationUser() {}
}

アノテーションの種類

Target指定

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

@Target(ElementType.ANNOTATION_TYPE)
@interface MetaTargetAnnotation {}

@Target(ElementType.CONSTRUCTOR)
@interface MetaTargetConstructor {}

@Target(ElementType.FIELD)
@interface MetaTargetField {}

@Target(ElementType.LOCAL_VARIABLE)
@interface MetaTargetLocalValue {}

@Target(ElementType.METHOD)
@interface MetaTargetMethod {}

@Target(ElementType.PACKAGE)
@interface MetaTargetPackage {}

@Target(ElementType.PARAMETER)
@interface MetaTargetParameter {}

@Target(ElementType.TYPE)
@interface MetaTargetType {}

@Target({ElementType.METHOD,ElementType.FIELD})
@interface MetaTargetMulti {}

Retention

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.SOURCE)
@interface MetaRetentionSource{}

@Retention(RetentionPolicy.CLASS)
@interface MetaRetentionClass{}

@Retention(RetentionPolicy.RUNTIME)
@interface MetaRetentionRuntime{}

Inherited

import java.lang.annotation.Inherited;

@Inherited
public @interface MetaInheritedAnnotation {}

@MetaInheritedAnnotation
class AbstractSample{}

class Sample extends AbstractSample{}

アノテーションの取得方法

package com.yoheim.java5.main;

import java.lang.annotation.Annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
@interface Marker{}

@Retention(RetentionPolicy.RUNTIME)
@interface SingleValue{
	String value() default "nothing";
}

@Marker
@SingleValue("something")
public class GetAnnotation {

	public static void main(String[] args){
		
		//全てのアノテーションを取得
		GetAnnotation me = new GetAnnotation(); 
		Annotation[] ans = me.getClass().getAnnotations();
		for (Annotation an : ans) {
			System.out.println("Annotation: " + an);
		}
		
		//指定したアノテーションを取得
		Annotation annotation = me.getClass().getAnnotation(SingleValue.class);
		SingleValue single = (SingleValue) annotation;
		//アノテーションの中身を取り出す
		System.out.println("SingleValue: " + single.value());
	}
}

アノテーションの活用例

package com.yoheim.java5.main;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.reflect.Field;

@Retention(RetentionPolicy.RUNTIME)
@interface CheckRequired{} //必須チェックを示すアノテーション

class User{
	@CheckRequired
	String id;

	@CheckRequired
	String name;
	
	String address;

	//getter・setterは省略
}

public class AnnoationUsingSamle {

	public static void main(String[] args) throws Exception {
		
		User user = getUser();
		checkUserInfo(user);
		System.out.println("OK");
	}

	//必須チェックを行う場所
	private static void checkUserInfo(User user) throws Exception {
		Field[] fields = user.getClass().getDeclaredFields();
		for (Field field : fields) {
			CheckRequired cr = field.getAnnotation(CheckRequired.class);
			if(cr != null){
				//必須チェック
				if(field.get(user) == null)
					throw new IllegalStateException();
			}
		}
	}

	private static User getUser() {
		User user = new User();
		user.id = "001";
		//user.name = "yoheim"; //必須のnameを指定しない。→checkに引っかかる。
		user.address = "Japan";
		return user;
	}
}

リファクタリング～美しいプログラムに向けて～

ここでは美しいプログラムを書くという目標のため、リファクタリングについて記述します。
美しいかどうかは、人によりけりかと思いますが。。。
ここでの美しいとは、読みやすいコード/保守しやすいコードという意味で仮に定義したいと思います。