自定义注解,简易版orm框架

本文深入探讨Java中的元注解,包括@Target、@Retention、@Documented和@Inherited,以及如何利用这些元注解创建一个简单的ORM框架。通过具体实例,展示如何在实体类中应用注解来映射数据库表和字段。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

目录

注解说明

代码


注解说明

元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解:
@Target

@Target说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

  1. CONSTRUCTOR:用于描述构造器
  2. FIELD:用于描述域-全局变量
  3. LOCAL_VARIABLE:用于描述局部变量
  4. METHOD:用于描述方法
  5. PACKAGE:用于描述包
  6. PARAMETER:用于描述参数
  7. TYPE:用于描述类、接口(包括注解类型) 或enum声明


2.@Retention

表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)
3.@Documented
4.@Inherited

代码

实现简单orm框架

定义两个注解

import java.lang.annotation.*;

/**
 * 映射表名
 */
@Target({ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface TableField {

    String value();

    String desc() default "";
}
import java.lang.annotation.*;

/**
 * 映射表字段
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface TableName {

    String value();

}

实体类 

import lombok.Data;

@Data
@TableName("user") // @TableName表名
public class UserEntity {

    @TableField("id") // @TableField对应的表字段
    public int id;

    @TableField("user_name")
    private String userName;

    @TableField("pass_word")
    private String passWord;

    @TableField("age")
    private int age;

}
import cn.hutool.core.util.StrUtil;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

public class TestTwoController {

    public static void main(String[] args) {
        // select 查询
        UserEntity userEntity = new UserEntity();
        userEntity.setId(10);
        userEntity.setUserName("栗子");
        userEntity.setPassWord("123456");
        userEntity.setAge(22);
        getSql(userEntity);

        // select in多个查询
        UserEntity userEntityTwo = new UserEntity();
        userEntityTwo.setUserName("栗子, 大栗子, 小栗子");
        userEntityTwo.setAge(20);
        getSql(userEntityTwo);
    }

    public static void getSql(UserEntity userEntity)  {
        // 通过反射获取对象
        Class userEntityClass = userEntity.getClass();
        // 获取类上的TableName注解
        TableName TableName = (TableName) userEntityClass.getAnnotation(TableName.class);

        // sb封装select内容
        StringBuffer sb = new StringBuffer();
        sb.append("select ");
        // where封装查询条件
        StringBuffer where = new StringBuffer();

        // 获取所有字段
        Field[] declaredFields = userEntityClass.getDeclaredFields();
        int a = declaredFields.length;
        for (Field field : declaredFields){
            a--;
            // 获取字段上TableField注解内容
            TableField annotation = field.getAnnotation(TableField.class);
            String tableName = annotation.value();
            // 拼接select字段
            if(a == 0){
                sb.append(tableName);
            }else{
                sb.append(tableName+", ");
            }

            // 字段名
            String fieldName = field.getName();
            if(StrUtil.isNotBlank(fieldName)){
                // 获取属性值
                Object valueByName = getFieldValueByName(fieldName, userEntity);
                // 类型判断,不为空
                if((valueByName instanceof String && valueByName != null) || (valueByName instanceof Integer && ((Integer) valueByName).intValue() != 0 )){
                    // 拼接 and 字段名
                    where.append(" and ").append(tableName);
                    // 判断是in多个条件查询还是普通查询
                    if(valueByName instanceof String && ((String) valueByName).contains(",")){
                        // 拼接in多个条件
                        String[] split = ((String) valueByName).split(",");
                        where.append(" in (");
                        for(int s = 0; s < split.length; s++){
                            if(s < split.length - 1){
                                where.append(split[s]).append(", ");
                            }else{
                                where.append(split[s]).append(")");
                            }
                        }
                    }else{// 拼接查询条件
                        where.append(" = ").append(valueByName);
                    }
                }
            }
        }

        // 拼接select和where
        sb.append(" from ").append(TableName.value()).append(" where 1 = 1");
        sb.append(where).append(";");

        System.out.println(sb.toString());
    }

    /**
     *  获取属性值
     *     - 反射获取getter属性值
     *
     * @param name 属性名
     * @param user 属性名所在的entity类
     * @return 属性值
     */
    public static Object getFieldValueByName(String name, Object user)  {
        // 第一个字符改大写
        String firstLetter = name.substring(0, 1).toUpperCase();
        // 拼装成getter方法名称
        String getter = "get" + firstLetter + name.substring(1);
        Method method;
        Object value;
        try {
            // 反射获值
            method = user.getClass().getMethod(getter, new Class[] {});
            value = method.invoke(user, new Class[] {});
            return value;
        }  catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

}

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

祁_z

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值