自己开发一个Java ORM框架(1)-通过注解描述映射关系

简介: 本文目录1. ORM概念2. XML实现简单的ORM映射3. 自定义注解4. 自定义注解信息的获取

1. ORM概念

ORM即Object Relation Mapping,Object就是对象,Relation就是关系数据库,Mapping映射,就是说Java中的对象和关系数据库中的表存在一种对应关系。


现在常见的ORM框架比如Hibernate和mybatis,都是采用了ORM的方式,基本原则就是类-表(Table)、属性-列(Column)这样的对应,所以一个对象就能表示数据表中的一行数据啦。


2. XML实现简单的ORM映射

使用XML实现简单的ORM映射还是非常直观的,加入有一张用户表结构如下:

image.png

对应的Java类如下:


package demo;

public class User {

private String userId;

private String userName;

}

那么我们可以使用下面的xml描述对象-关系映射(具体的节点名、属性名都是随意设计的,只是为了说明意思):

<?xml version="1.0" encoding="UTF-8"?>
<!-- orm是所有映射的根节点 -->
<orm>
  <!-- 每对映射使用一个mapping节点 -->
  <mapping class="orm.User" table="User">
    <property name="userId" column="user_id"/>
    <property name="userName" column="user_name"/>
  </mapping>
</orm>

实际上,有了上面的xml文件,orm.User对象和User表的映射就建立明白了。当ORM框架运作的时候,只需要从xml加载这一个映射关系,就能知道对User对象进行操作时,该对那张表那些列进行操作了。从xml文件中读取数据的方法也有很多,此处不再介绍。


3. 自定义注解

之前的xml配置文件是描述映射的,这些描述完全可以使用注解来实现,笔者感觉会更加简洁、直接。


既然是自定义注解,我们首先需要了解哪些是方面是可以自定义的:


1,可以自定义注解应用的元素。Java注解可以应用于包、类(接口)、方法、属性、构造器等,一般常用的也就类(接口)、方法、属性。


2,可以自定义注解使用的时机。比如是否编译的时候就把注解的信息丢掉,比如JVM运行时还是保留注解信息。如果运行时保留的话,就可以通过反射读取注解的内容了,所以自定义注解里面保存的ORM映射信息是可以在程序运行时使用的。


3,是否将注解包含在Javadoc帮助文档里面。


OK,口说太空洞我们来定义一个最简单注解,该注解的作用非常简单,就是说明类与数据库表的映射关系。自定义类使用的关键字是class,自定义注解使用的关键字更加高端的关键字**@interface**。

package demo;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)//该注解用于修饰TYPE元素,也就是修饰类和接口等类型
@Retention(RetentionPolicy.RUNTIME)//该注解信息运行时保留
@Documented//该注解包含在Javadoc中
public @interface Table {//注解名为Table
  //此处需要注意,注解中的每个方法表示该注解的一个可配置参数,default表示该配置参数的默认值
  public String tableName() default "";
}

将该注解应用于User就是:

package demo;
//@Table对应自定义注解,tableName对应自定义注解中的方法,如果只用@Table则表示tableName采用默认的""作为值
@Table(tableName="User")
public class User {
  private String userId;
  private String userName;
}

接下来就是需要详细的了解下@Target和@Retention的用法了,因为他俩决定了如何去定义一个注解。

@Target(ElementType.TYPE):表示注解用以修饰类、接口、enum、注解。
@Target(ElementType.FIELD):表示注解用以修饰属性
@Target(ElementType.METHOD):表示注解用以方法   
@Retention(RetentionPolicy.SOURCE):源码之中是有的,编译时候丢弃
@Retention(RetentionPolicy.CLASS):编译后.class文件中还有,JVM丢弃之,所以运行时也看不到
@Retention(RetentionPolicy.RUNTIME):表示注解运行时可用

根据以上描述,我们需要自定义两个注解,分别用来描述类-表对应关系及属性-列对应关系,所以全部的源码应为:

//1,Table注解,描述类与表对应
package demo;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)//该注解用于修饰TYPE元素,也就是修饰类和接口等类型
@Retention(RetentionPolicy.RUNTIME)//该注解信息运行时保留
@Documented//该注解包含在Javadoc中
public @interface Table {//注解名为Table
  //此处需要注意,注解中的每个方法表示该注解的一个可配置参数,default表示该配置参数的默认值
  public String tableName() default "";
}
//2,Column注解,描述属性与列对应
package demo;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
  public String columnName() default "";
}
//3,注解应用在User类上
package demo;
//@Table对应自定义注解,tableName对应自定义注解中的方法,如果只用@Table则表示tableName采用默认的""作为值
@Table(tableName="User")
public class User {
  @Column(columnName="user_id")
  private String userId;
  @Column(columnName="user_name")
  private String userName;
}

4. 自定义注解信息的获取

之前分别使用xml和注解描述了User类和User表的对应关系,xml可以通过Java语言文件流等方式直接读取,而注解包含信息该如何读取呢。


既然注解是包含在Java语言中的信息,实际上可以通过反射来读取注解信息,对上述User类中注解读取的方法如下:

package demo;
import java.lang.reflect.Field;
@Table(tableName="User")
public class User {
  @Column(columnName="user_id")
  private String userId;
  @Column(columnName="user_name")
  private String userName;
  public static void main(String[] args){
    Class userClass=User.class;//获取User类信息
    if(userClass.isAnnotationPresent(Table.class)){//判断userClass是否使用了Table注解
      Table table=(Table)userClass.getAnnotation(Table.class);//获取注解信息
      System.out.println(table.tableName());//输出Table注解的tableName参数
    }
    Field[] fields = userClass.getDeclaredFields();
    for(Field field:fields){//遍历属性
      if(field.isAnnotationPresent(Column.class)){//具备Column注解
        Column column=(Column)field.getAnnotation(Column.class);//获取注解信息
        System.out.println(column.columnName());
      }
      }
  }
}

运行后输出结果:

User
user_id
user_name
• 1
• 2
• 3

可见通过反射,可以轻易的获取注解的信息。

相关文章
|
3天前
|
机器学习/深度学习 人工智能 NoSQL
JAVA接入DeepSeek大模型接口开发---阿里云的百炼模型
随着大模型的越来越盛行,现在很多企业开始接入大模型的接口,今天我从java开发角度来写一个demo的示例,用于接入DeepSeek大模型,国内的大模型有很多的接入渠道,今天主要介绍下阿里云的百炼模型,因为这个模型是免费的,只要注册一个账户,就会免费送百万的token进行学习,今天就从一个简单的可以执行的示例开始进行介绍,希望可以分享给各位正在学习的同学们。
76 3
JAVA接入DeepSeek大模型接口开发---阿里云的百炼模型
|
2天前
|
机器学习/深度学习 人工智能 Java
Java机器学习实战:基于DJL框架的手写数字识别全解析
在人工智能蓬勃发展的今天,Python凭借丰富的生态库(如TensorFlow、PyTorch)成为AI开发的首选语言。但Java作为企业级应用的基石,其在生产环境部署、性能优化和工程化方面的优势不容忽视。DJL(Deep Java Library)的出现完美填补了Java在深度学习领域的空白,它提供了一套统一的API,允许开发者无缝对接主流深度学习框架,将AI模型高效部署到Java生态中。本文将通过手写数字识别的完整流程,深入解析DJL框架的核心机制与应用实践。
21 2
|
23天前
|
人工智能 安全 IDE
一天成为Java开发高手:用飞算JavaAI实现十倍提效
“一天成为Java开发高手”曾被视为天方夜谭,但飞算JavaAI的出现改变了这一局面。这款AI开发助手通过智能引导、需求分析、自动化逻辑处理和完整代码工程生成,大幅简化了Java开发流程。它不仅帮助新手快速上手,还让资深开发者提高效率,减少调试时间。现在,参与“飞算JavaAI炫技赛”,展示你的开发实力,赢取丰厚奖品!
|
16天前
|
Oracle Java 关系型数据库
课时37:综合实战:数据表与简单Java类映射转换
今天我分享的是数据表与简单 Java 类映射转换,主要分为以下四部分。 1. 映射关系基础 2. 映射步骤方法 3. 项目对象配置 4. 数据获取与调试
|
4天前
|
存储 并行计算 Java
java 中的fork join框架
Java中的Fork Join框架于Java 7引入,旨在提升并行计算能力。它通过“分而治之”的思想,将大任务拆分为多个小任务(fork),再将结果合并(join)。核心组件包括:ForkJoinPool(管理线程池和工作窃取机制)、ForkJoinWorkerThread(执行具体任务的工作线程)和ForkJoinTask(定义任务逻辑,常用子类为RecursiveAction和RecursiveTask)。框架支持通过invoke、fork/join等方式提交任务,广泛应用于高性能并发场景。
|
14天前
|
搜索推荐 Java Android开发
课时146:使用JDT开发Java程序
在 Eclipse 之中提供有 JDT环境可以实现java 程序的开发,下面就通过一些功能进行演示。 项目开发流程
|
16天前
|
存储 监控 数据可视化
SaaS云计算技术的智慧工地源码,基于Java+Spring Cloud框架开发
智慧工地源码基于微服务+Java+Spring Cloud +UniApp +MySql架构,利用传感器、监控摄像头、AI、大数据等技术,实现施工现场的实时监测、数据分析与智能决策。平台涵盖人员、车辆、视频监控、施工质量、设备、环境和能耗管理七大维度,提供可视化管理、智能化报警、移动智能办公及分布计算存储等功能,全面提升工地的安全性、效率和质量。
|
24天前
|
存储 监控 Java
【Java并发】【线程池】带你从0-1入门线程池
欢迎来到我的技术博客!我是一名热爱编程的开发者,梦想是编写高端CRUD应用。2025年我正在沉淀中,博客更新速度加快,期待与你一起成长。 线程池是一种复用线程资源的机制,通过预先创建一定数量的线程并管理其生命周期,避免频繁创建/销毁线程带来的性能开销。它解决了线程创建成本高、资源耗尽风险、响应速度慢和任务执行缺乏管理等问题。
155 60
【Java并发】【线程池】带你从0-1入门线程池
|
13天前
|
存储 网络协议 安全
Java网络编程,多线程,IO流综合小项目一一ChatBoxes
**项目介绍**:本项目实现了一个基于TCP协议的C/S架构控制台聊天室,支持局域网内多客户端同时聊天。用户需注册并登录,用户名唯一,密码格式为字母开头加纯数字。登录后可实时聊天,服务端负责验证用户信息并转发消息。 **项目亮点**: - **C/S架构**:客户端与服务端通过TCP连接通信。 - **多线程**:采用多线程处理多个客户端的并发请求,确保实时交互。 - **IO流**:使用BufferedReader和BufferedWriter进行数据传输,确保高效稳定的通信。 - **线程安全**:通过同步代码块和锁机制保证共享数据的安全性。
65 23
|
20天前
|
Java 调度
【源码】【Java并发】【线程池】邀请您从0-1阅读ThreadPoolExecutor源码
当我们创建一个`ThreadPoolExecutor`的时候,你是否会好奇🤔,它到底发生了什么?比如:我传的拒绝策略、线程工厂是啥时候被使用的? 核心线程数是个啥?最大线程数和它又有什么关系?线程池,它是怎么调度,我们传入的线程?...不要着急,小手手点上关注、点赞、收藏。主播马上从源码的角度带你们探索神秘线程池的世界...
91 0
【源码】【Java并发】【线程池】邀请您从0-1阅读ThreadPoolExecutor源码