Java注解(Annotation)用法：利用注解和反射机制指定列名导出数据库数据

　　闲来没事，想了一个应用的例子：用java如何把数据库的数据根据我们指定的某几列，如第2列，第4列，第6列导出来到Excel里？

写代码也是为了应用的，写好的代码更重要的是在于思考。我自己思考了这个示例。

问题：指定列把数据库数据根据列导出到Excel里。

　　那么要处理这个问题，它其实是很简单的，但是再简单的问题，也需要去拆分，思考，所谓，麻雀虽小，五脏俱全嘛。

拆分：1. Load DB data; 2. 把数据和指定列映射起来；3. 导出数据到Excel。

　　本文把第一步操作省略了，第一步操作就是读取数据库的数据，然后把它映射到Entity上去，也就是下面代买的Student.java，我们假设这一步已经成功。

以下三个类重点实现第二步，第三步，只要把已经map好的数据，导出到Excel，可以利用apache poi，详见前一篇文章：java POI创建Excel示例（xslx和xsl区别 ）

　　第二步的实现我之前想着是直接把类的get方法用case的方式跟传进去的参数一一匹配，然后每次写数据的时候执行那个方法来获取当前要导出的列的数据。

如下：

 public static Object getStudentInfo(Student student, int index) {
     switch(index) {
     case 1 :
         return student.getName();
     case 2 :
         return student.getSex();
     ...
     }
 }

可是这样看起来太傻逼了，于是接着想有没有比较合理的方式实现呢？

后来想到了用注解和java的反射机制来实现。

现在java注解用途越来越广泛了，如Google的Guice，一轻量级的IOC框架，大有跟Spring抗衡的趋势。

我就用注解来标注get方法获取的数据在数据库中对应列的索引，然后，根据传进去的列数组匹配get方法，再利用java的反射，执行方法体获取列的数据。具体代码如下。

MapValue是一个Annotation，里面只有一个index()方法，用来标注方法的索引。

 package com.cnblogs.rolf.dao;

 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 /**
  * 放在方法上的注解，这个注解可以映射方法的索引
  * @author 草原战狼
  *
  */
 @Target(value = {ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface MapValue {
     /**
      * 标注方法的索引
      * @return 方法索引值
      */
     int index() default 0;
 }

View MapValue Code

Student类是用来map到数据库的实体类，上面的get方法用MapValue标注了它在数据库中表列的顺序。

 package com.cnblogs.rolf.entity;

 import com.cnblogs.rolf.dao.MapValue;

 /**
  * Student 相当于一个表的实体类，我们可以假想它是从数据库读出来映射出来的一张表信息
  * STUDENT_COLUMN_NAMES： 这张表的类名
  * @author 草原战狼
  *
  */
 public class Student {
     public static String[] STUDENT_COLUMN_NAMES = {"Name", "Sex", "Age", "Height", "Weight", "Grade"};
     private String name;
     private String sex;
     private int age;
     private int height;
     private int weigth;
     private int grade;

     public Student(String name, String sex, int age, int height, int weight, int grade) {
         this.name = name;
         this.sex = sex;
         this.height = height;
         this.weigth = weight;
         this.age = age;
         this.grade = grade;
     }
     public Student() {

     }

     @MapValue(index = 1)
     public String getName() {
         return name;
     }
     public void setName(String name) {
         this.name = name;
     }
     @MapValue(index = 2)
     public String getSex() {
         return sex;
     }
     public void setSex(String sex) {
         this.sex = sex;
     }
     @MapValue(index = 3)
     public int getAge() {
         return age;
     }
     public void setAge(int age) {
         this.age = age;
     }
     @MapValue(index = 4)
     public int getHeight() {
         return height;
     }
     public void setHeight(int height) {
         this.height = height;
     }
     @MapValue(index = 5)
     public int getWeigth() {
         return weigth;
     }
     public void setWeigth(int weigth) {
         this.weigth = weigth;
     }
     @MapValue(index = 6)
     public int getGrade() {
         return grade;
     }
     public void setGrade(int grade) {
         this.grade = grade;
     }
 }

View Student Code

TestMain是测试的类，里面还有两个方法，这两个方法是用来处理实体类和要导出列数组的匹配。

 package com.cnblogs.rolf;

 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;

 import com.cnblogs.rolf.dao.MapValue;
 import com.cnblogs.rolf.entity.Student;
 /**
  * 可以应用在从数据库导出数据，根据指定要导出的列，导出到Excel， Word等。这个只是中间的环节
  * @author 草原战狼
  *
  */
 public class TestMain {
     public static void main(String[] args) {
         Student student = new Student("XiaoMing", "Male", 20, 175, 135, 2);
         int[] indexs = {34,2,5,3,0,1,2,4,6};
         System.out.println(student.getAge());
         String[] names = Student.STUDENT_COLUMN_NAMES;
         String printColumns = getColumnName(names, indexs);
         String pringStudentInfo = getStudentInfo(student, indexs);
         System.out.println(printColumns);
         System.out.println(pringStudentInfo);
     }
     /**
      * 接收一张表的实体类和外面传进来的要导出的列的索引顺序，比如要导出第2列，第4列，那么可以传入{2,4}
      * 返回获取到的指定列的值
      * @param student 表的实体类
      * @param indexs 要导出的列的索引
      * @return 指定列的值
      */
     public static String getStudentInfo(Student student, int[] indexs) {
         String studentInfo = "";
         Method[] methods = Student.class.getMethods();
         for(int index : indexs) {
             for(Method method : methods) {
                 MapValue mapValue = method.getAnnotation(MapValue.class);
                 if(mapValue == null){
                     continue;
                 }else {
                     if(index == mapValue.index()) {
                         Object value = null;
                         try {
                             value = method.invoke(student);
                         } catch (IllegalAccessException
                                 | IllegalArgumentException
                                 | InvocationTargetException e) {
                             System.out.println("parameters number is wrong.");
                             e.printStackTrace();
                         }
                         studentInfo += value.toString() + ", ";
                         break;
                     }
                 }
             }
         }
         return studentInfo;
     }
     /**
      * 根据指定的索引导出列的名称
      * @param names 整张表所有列的名称
      * @param indexs 要导出的列的索引
      * @return 导出的列的名称
      */
     public static String getColumnName(String[] names, int[] indexs) {
         String result = "";
         for(int index : indexs) {
             if(index > names.length || index < 1) {
                 continue;
             }
             result += names[index - 1] + ", ";
         }
         return result;
     }
 }

View TestMain Code

测试的结果：

Sex, Weight, Age, Name, Sex, Height, Grade,
Male, 135, 20, XiaoMing, Male, 175, 2, 

草原战狼淘宝小店：http://xarxf.taobao.com/ 淘宝搜小矮人鞋坊，主营精致美丽时尚女鞋，为您的白雪公主挑一双哦。谢谢各位博友的支持。

====================================================================================

======================    以上分析仅代表个人观点，欢迎指正与交流   =========================

======================    草原战狼博客，转载请注明出处，万分感谢   =========================

====================================================================================