how2j.cn

下载区
文件名 文件大小
mysql-connector-java-5.0.8-bin.jar 528k

工具版本兼容问题
在本例中,把数据库连接的工具类DBUtil改造成为注解的方式,来举例演示怎么自定义注解以及如何解析这些自定义注解


步骤 1 : 非注解方式DBUtil   
步骤 2 : 自定义注解@JDBCConfig   
步骤 3 : 注解方式DBUtil   
步骤 4 : 解析注解   

步骤 1 :

非注解方式DBUtil

edit
通常来讲,在一个基于JDBC开发的项目里,都会有一个DBUtil这么一个类,在这个类里统一提供连接数据库的IP地址,端口,数据库名称, 账号,密码,编码方式等信息。如例所示,在这个DBUtil类里,这些信息,就是以属性的方式定义在类里的。

大家可以运行试试,运行结果是获取一个连接数据库test的连接Connection实例。
注: 运行需要用到连接mysql的jar包,如果没有,可在右侧下载
package util; import java.sql.Connection; import java.sql.DriverManager; import java.sql.SQLException; public class DBUtil { static String ip = "127.0.0.1"; static int port = 3306; static String database = "test"; static String encoding = "UTF-8"; static String loginName = "root"; static String password = "admin"; static{ try { Class.forName("com.mysql.jdbc.Driver"); } catch (ClassNotFoundException e) { e.printStackTrace(); } } public static Connection getConnection() throws SQLException { String url = String.format("jdbc:mysql://%s:%d/%s?characterEncoding=%s", ip, port, database, encoding); return DriverManager.getConnection(url, loginName, password); } public static void main(String[] args) throws SQLException { System.out.println(getConnection()); } }
步骤 2 :

自定义注解@JDBCConfig

edit
接下来,就要把DBUtil这个类改造成为支持自定义注解的方式。 首先创建一个注解JDBCConfig

1. 创建注解类型的时候即不使用class也不使用interface,而是使用@interface

public @interface JDBCConfig

2. 元注解
@Target({METHOD,TYPE}) 表示这个注解可以用用在类/接口上,还可以用在方法上
@Retention(RetentionPolicy.RUNTIME) 表示这是一个运行时注解,即运行起来之后,才获取注解中的相关信息,而不像基本注解如@Override 那种不用运行,在编译时eclipse就可以进行相关工作的编译时注解。
@Inherited 表示这个注解可以被子类继承
@Documented 表示当执行javadoc的时候,本注解会生成相关文档
请在学习完本知识点最后一个步骤解析注解之后,再查看 元注解,做更详尽的学习。

3. 注解元素,这些注解元素就用于存放注解信息,在解析的时候获取出来

String ip();
int port() default 3306;
String database();
String encoding();
String loginName();
String password();
package anno; import static java.lang.annotation.ElementType.METHOD; import static java.lang.annotation.ElementType.TYPE; import java.lang.annotation.Documented; import java.lang.annotation.Inherited; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target({METHOD,TYPE}) @Retention(RetentionPolicy.RUNTIME) @Inherited @Documented public @interface JDBCConfig { String ip(); int port() default 3306; String database(); String encoding(); String loginName(); String password(); }
步骤 3 :

注解方式DBUtil

edit
有了自定义注解@JDBCConfig之后,我们就把非注解方式DBUtil改造成为注解方式DBUtil。
如例所示,数据库相关配置信息本来是以属性的方式存放的,现在改为了以注解的方式,提供这些信息了。

注: 目前只是以注解的方式提供这些信息,但是还没有解析,接下来进行解析
package util; import anno.JDBCConfig; @JDBCConfig(ip = "127.0.0.1", database = "test", encoding = "UTF-8", loginName = "root", password = "admin") public class DBUtil { static { try { Class.forName("com.mysql.jdbc.Driver"); } catch (ClassNotFoundException e) { e.printStackTrace(); } } }
package util;

import anno.JDBCConfig;

@JDBCConfig(ip = "127.0.0.1", database = "test", encoding = "UTF-8", loginName = "root", password = "admin")
public class DBUtil {
	static {
		try {
			Class.forName("com.mysql.jdbc.Driver");
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}
	}

}
接下来就通过反射,获取这个DBUtil这个类上的注解对象

JDBCConfig config = DBUtil.class.getAnnotation(JDBCConfig.class);

拿到注解对象之后,通过其方法,获取各个注解元素的值:

String ip = config.ip();
int port = config.port();
String database = config.database();
String encoding = config.encoding();
String loginName = config.loginName();
String password = config.password();

后续就一样了,根据这些配置信息得到一个数据库连接Connection实例。
注: 运行需要用到连接mysql的jar包,如果没有,可在右侧下载
package util; import java.sql.Connection; import java.sql.DriverManager; import java.sql.SQLException; import anno.JDBCConfig; @JDBCConfig(ip = "127.0.0.1", database = "test", encoding = "UTF-8", loginName = "root", password = "admin") public class DBUtil { static { try { Class.forName("com.mysql.jdbc.Driver"); } catch (ClassNotFoundException e) { e.printStackTrace(); } } public static Connection getConnection() throws SQLException, NoSuchMethodException, SecurityException { JDBCConfig config = DBUtil.class.getAnnotation(JDBCConfig.class); String ip = config.ip(); int port = config.port(); String database = config.database(); String encoding = config.encoding(); String loginName = config.loginName(); String password = config.password(); String url = String.format("jdbc:mysql://%s:%d/%s?characterEncoding=%s", ip, port, database, encoding); return DriverManager.getConnection(url, loginName, password); } public static void main(String[] args) throws NoSuchMethodException, SecurityException, SQLException { Connection c = getConnection(); System.out.println(c); } }


HOW2J公众号,关注后实时获知最新的教程和优惠活动,谢谢。


问答区域    
2020-11-12 自定义注解类型中的元素 写法
xiaokun




注解类型中的元素 如示例代码中 String ip(); 中 括号的作用是什么?
@Target({METHOD,TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface JDBCConfig {
     String ip();
     int port() default 3306;
     String database();
     String encoding();
     String loginName();
     String password();
}

							


3 个答案

莫諾
答案时间:2022-01-21
一种解释,也许是曲解
ip() 是个String类型的方法返回值;

yagao
答案时间:2021-07-13
可以理解注解是一种特殊的接口,所有注解内定义的元素看成是接口定义的方法。 在使用注解时,相当于实现了这个接口的方法,使用时的@JDBCConfig(ip="127.0.0.1"),这个给ip赋值的value就相当于自定义注解时String ip()这个方法的返回。 所以,在下面用到的时候,这个config.ip()的返回就是使用这个注解时ip的value

lang1928
答案时间:2020-12-11
同问



回答已经提交成功,正在审核。 请于 我的回答 处查看回答记录,谢谢
答案 或者 代码至少填写一项, 如果是自己有问题,请重新提问,否则站长有可能看不到





2020-09-24 这个例子举得蛋疼
372901abc

地方




1 个答案

啊哈哈哈哈查查
答案时间:2022-12-19
同感



回答已经提交成功,正在审核。 请于 我的回答 处查看回答记录,谢谢
答案 或者 代码至少填写一项, 如果是自己有问题,请重新提问,否则站长有可能看不到




2019-01-21 对着程序运行异常
2018-11-02 第3步:注解方式DBUtil
2018-05-30 MYSQL URL写法


提问太多,页面渲染太慢,为了加快渲染速度,本页最多只显示几条提问。还有 4 条以前的提问,请 点击查看

提问之前请登陆
提问已经提交成功,正在审核。 请于 我的提问 处查看提问记录,谢谢
关于 JAVA 高级-注解-自定义注解 的提问

尽量提供截图代码异常信息,有助于分析和解决问题。 也可进本站QQ群交流: 578362961
提问尽量提供完整的代码,环境描述,越是有利于问题的重现,您的问题越能更快得到解答。
对教程中代码有疑问,请提供是哪个步骤,哪一行有疑问,这样便于快速定位问题,提高问题得到解答的速度
在已经存在的几千个提问里,有相当大的比例,是因为使用了和站长不同版本的开发环境导致的,比如 jdk, eclpise, idea, mysql,tomcat 等等软件的版本不一致。
请使用和站长一样的版本,可以节约自己大量的学习时间。 站长把教学中用的软件版本整理了,都统一放在了这里, 方便大家下载: https://how2j.cn/k/helloworld/helloworld-version/1718.html

上传截图