java自定义注解有什么用 java中注释和注解于什么区别啊

编程之家 2023-10-12 83次浏览

大家好，今天来为大家解答java自定义注解有什么用这个问题的一些问题点，包括java中注释和注解于什么区别啊也一样很多人还不知道，因此呢，今天就来为大家分析分析，现在让我们一起来看看吧！如果解决了您的问题，还望您关注下本站哦，谢谢~

java中注释和注解于什么区别啊

首先来说注释有三种：///**//***/前两种编译器直接跳过，从来不阅读，第三种编译器是可以看懂的，当你使用javadoc这样的命令时会用到，用来生成API时用的。

注解：这东东完全就是给编译器看的。比如@Ovrride表示这个方法是重写了父类中的方法，而不是自定义的，所以这个时候编译器会去检查你的方法名是否和父类一样，是否写错了。

起初，注解是比较简单的，后来注解里面可以加入变量和参数，以节省代码（这些代码都是大家共同认可的，用一个公式给代替了）

注解是对计算机的说明，也可以不用注解，自己写代码告诉计算机编译器。注解其实就是代码，只是看起来和我们自己写的有点不一样而已。也是代码的一部分，学习Hibernate和Spring等的时候会大量用到注解，用来节省大量代码。

java内部注解是如何实现的

用一个词就可以描述注解，那就是元数据，即一种描述数据的数据。所以，可以说注解就是源代码的元数据。比如，下面这段代码：

@Override

public String toString(){

return"This is String Representation of current object.";

}

上面的代码中，我重写了toString()方法并使用了@Override注解。但是，即使我不使用@Override注解标记代码，程序也能够正常执行。那么，该注解表示什么？这么写有什么好处吗？事实上，@Override告诉编译器这个方法是一个重写方法(描述方法的元数据)，如果父类中不存在该方法，编译器便会报错，提示该方法没有重写父类中的方法。如果我不小心拼写错误，例如将toString()写成了toStrring(){double r}，而且我也没有使用@Override注解，那程序依然能编译运行。但运行结果会和我期望的大不相同。现在我们了解了什么是注解，并且使用注解有助于阅读程序。

Annotation是一种应用于类、方法、参数、变量、构造器及包声明中的特殊修饰符。它是一种由JSR-175标准选择用来描述元数据的一种工具。

为什么要引入注解？

使用Annotation之前(甚至在使用之后)，XML被广泛的应用于描述元数据。不知何时开始一些应用开发人员和架构师发现XML的维护越来越糟糕了。他们希望使用一些和代码紧耦合的东西，而不是像XML那样和代码是松耦合的(在某些情况下甚至是完全分离的)代码描述。如果你在Google中搜索“XML vs. annotations”，会看到许多关于这个问题的辩论。最有趣的是XML配置其实就是为了分离代码和配置而引入的。上述两种观点可能会让你很疑惑，两者观点似乎构成了一种循环，但各有利弊。下面我们通过一个例子来理解这两者的区别。

假如你想为应用设置很多的常量或参数，这种情况下，XML是一个很好的选择，因为它不会同特定的代码相连。如果你想把某个方法声明为服务，那么使用Annotation会更好一些，因为这种情况下需要注解和方法紧密耦合起来，开发人员也必须认识到这点。

另一个很重要的因素是Annotation定义了一种标准的描述元数据的方式。在这之前，开发人员通常使用他们自己的方式定义元数据。例如，使用标记interfaces，注释，transient关键字等等。每个程序员按照自己的方式定义元数据，而不像Annotation这种标准的方式。

目前，许多框架将XML和Annotation两种方式结合使用，平衡两者之间的利弊。

Annotation是如何工作的？怎么编写自定义的Annotation？

在讲述这部分之前，建议你首先下载Annotation的示例代码AnnotationsSample.zip。下载之后放在你习惯使用的IDE中，这些代码会帮助你更好的理解Annotation机制。

编写Annotation非常简单，可以将Annotation的定义同接口的定义进行比较。我们来看两个例子：一个是标准的注解@Override，另一个是用户自定义注解@Todo。

@Target(ElementType.METHOD)

@Retention(RetentionPolicy.SOURCE)

public@interface Override{

}

对于@Override注释你可能有些疑问，它什么都没做，那它是如何检查在父类中有一个同名的函数呢。当然，不要惊讶，我是逗你玩的。@Override注解的定义不仅仅只有这么一点代码。这部分内容很重要，我不得不再次重复：Annotations仅仅是元数据，和业务逻辑无关。理解起来有点困难，但就是这样。如果Annotations不包含业务逻辑，那么必须有人来实现这些逻辑。元数据的用户来做这个事情。Annotations仅仅提供它定义的属性(类/方法/包/域)的信息。Annotations的用户(同样是一些代码)来读取这些信息并实现必要的逻辑。

当我们使用Java的标注Annotations(例如@Override)时，JVM就是一个用户，它在字节码层面工作。到这里，应用开发人员还不能控制也不能使用自定义的注解。因此，我们讲解一下如何编写自定义的Annotations。

我们来逐个讲述编写自定义Annotations的要点。上面的例子中，你看到一些注解应用在注解上。

J2SE5.0版本在 java.lang.annotation提供了四种元注解，专门注解其他的注解：

@Documented–注解是否将包含在JavaDoc中

@Retention–什么时候使用该注解

@Target?–注解用于什么地方

@Inherited–是否允许子类继承该注解

@Documented–一个简单的Annotations标记注解，表示是否将注解信息添加在java文档中。

@Retention–定义该注解的生命周期。

RetentionPolicy.SOURCE–在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override,@SuppressWarnings都属于这类注解。

RetentionPolicy.CLASS–在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式。

RetentionPolicy.RUNTIME–始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

@Target–表示该注解用于什么地方。如果不明确指出，该注解可以放在任何地方。以下是一些可用的参数。需要说明的是：属性的注解是兼容的，如果你想给7个属性都添加注解，仅仅排除一个属性，那么你需要在定义target包含所有的属性。

ElementType.TYPE:用于描述类、接口或enum声明

ElementType.FIELD:用于描述实例变量

ElementType.METHOD

ElementType.PARAMETER

ElementType.CONSTRUCTOR

ElementType.LOCAL_VARIABLE

ElementType.ANNOTATION_TYPE另一个注释

ElementType.PACKAGE用于记录java文件的package信息

@Inherited–定义该注释和子类的关系

那么，注解的内部到底是如何定义的呢？Annotations只支持基本类型、String及枚举类型。注释中所有的属性被定义成方法，并允许提供默认值。

@Target(ElementType.METHOD)

@Retention(RetentionPolicy.RUNTIME)

@interface Todo{

public enum Priority{LOW, MEDIUM, HIGH}

public enum Status{STARTED, NOT_STARTED}

String author() default"Yash";

Priority priority() default Priority.LOW;

Status status() default Status.NOT_STARTED;

}

下面的例子演示了如何使用上面的注解。

@Todo(priority= Todo.Priority.MEDIUM, author="Yashwant", status= Todo.Status.STARTED)

public void incompleteMethod1(){

//Some business logic is written

//But it’s not complete yet

}

如果注解中只有一个属性，可以直接命名为“value”，使用时无需再标明属性名。

@interface Author{

String value();

}

@Author("Yashwant")

public void someMethod(){

}

但目前为止一切看起来都还不错。我们定义了自己的注解并将其应用在业务逻辑的方法上。现在我们需要写一个用户程序调用我们的注解。这里我们需要使用反射机制。如果你熟悉反射代码，就会知道反射可以提供类名、方法和实例变量对象。所有这些对象都有getAnnotation()这个方法用来返回注解信息。我们需要把这个对象转换为我们自定义的注释(使用 instanceOf()检查之后)，同时也可以调用自定义注释里面的方法。看看以下的实例代码，使用了上面的注解:

Class businessLogicClass= BusinessLogic.class;

for(Method method: businessLogicClass.getMethods()){

Todo todoAnnotation=(Todo)method.getAnnotation(Todo.class);

if(todoAnnotation!= null){

System.out.println(" Method Name:"+ method.getName());

System.out.println(" Author:"+ todoAnnotation.author());

System.out.println(" Priority:"+ todoAnnotation.priority());

System.out.println(" Status:"+ todoAnnotation.status());

}

如何创建,使用以及解析自定义注解

首先要想使用自定义注解，必须创建自己的注解类

右键项目，new-> Annotation

然后在注解里定义自己的方法，该方法是别的类使用注解时需要填的属性

package com.sy.demo.annotation;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)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic@interface Table{public String value();}

注：如果只有一个方法时，应该用value()来指定方法名，这样就可以直接简写@Table("xxx")而不是@Table(aaa="xxx");

其中注解类上的注解称为元注解

@Target(ElementType.TYPE)

@Target的意思是，该注解类是放在什么位置的，是放在类上、字段上还是方法上，ElementType.TYPE意思是只能放在类上或接口上，ElementType.FIELD意思是只能放在字段上等等。

如果有多个位置选择可以这么写：

@Target({ElementType.TYPE, ElementType.METHOD})

@Retention(RetentionPolicy.RUNTIME)

意思是作用域，一般写RUNTIME就行

@Documented

意思是是否在生成JavaDoc时加入该注解类，这个看情况写不写

还有其他元注解，想要研究的就自己研究吧

定义完自定义注解了，下面就是使用的时候了

package com.sy.demo.entity;import com.sy.demo.annotation.Column;import com.sy.demo.annotation.Table;@Table("tdb_user")public class User{@Column("id") private Long id;@Column("email") private String email;@Column("password") private String password; public Long getId(){ return id;} public void setId(Long id){ this.id= id;} public String getEmail(){ return email;} public void setEmail(String email){ this.email= email;} public String getPassword(){ return password;} public void setPassword(String password){ this.password= password;}}

在这里我定义了一个实体类，用于表示用户信息，其中还是用了一个@Column类，代码如下

package com.sy.demo.annotation;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)@Documentedpublic@interface Column{ public String value();}

由代码可知，@Column是放在field上的

使用也使用完了，下面该是解析的时候了。

package com.sy.demo.util;import java.lang.reflect.Field;import com.sy.demo.annotation.Column;import com.sy.demo.annotation.Table;public class SqlUtil{ private static final String EMPTY="";@SuppressWarnings("unchecked") public static String getSql(Object object){ StringBuilder sb= new StringBuilder(); Class<Object> c; boolean isExist; Column column; String columnName; String getMethodName; Object columnValue; String[] strs; try{ c=(Class<Object>) object.getClass(); isExist= c.isAnnotationPresent(Table.class); if(!isExist){ return EMPTY;} Table table= c.getAnnotation(Table.class); sb.append(" SELECT* FROM"+ table.value()+" WHERE 1= 1"); Field[] fields= c.getDeclaredFields(); for(Field field: fields){ isExist= field.isAnnotationPresent(Column.class); if(!isExist){ continue;} column= field.getAnnotation(Column.class); columnName= column.value(); getMethodName="get"+ columnName.substring(0, 1).toUpperCase()+ columnName.substring(1); columnValue= c.getMethod(getMethodName, new Class[0]).invoke(object, new Object[0]); if(columnValue== null){ continue;} if(columnValue instanceof String){ columnValue=(String)columnValue; if(((String) columnValue).contains(",")){ sb.append("AND"+ columnName+" IN("); strs=((String) columnValue).split(","); for(String str: strs){ sb.append("'"+ str+"',");} sb.deleteCharAt(sb.length()- 1); sb.append(")");} else{ sb.append("AND"+ columnName+"='"+ columnValue+"'");}} else if(columnValue instanceof Integer|| columnValue instanceof Long){ sb.append("AND"+ columnName+"="+ columnValue+"");}}} catch(Exception e){ e.printStackTrace();} return sb.toString();}}

解析的时候用的是反射机制，可能看着比较麻烦比较乱，而且也新手可能也不太理解，在用的时候会发现其实还是挺方便的。

原理解释根据反射找到User类，在判断是否有注解，接着拼接sql什么的

整个列子项目中完整的代码如下(有许多步骤测试用例，懒得删了，全贴出来吧）

Controller

package com.sy.demo.controller;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.ResponseBody;import com.sy.demo.entity.User;import com.sy.demo.service.IUserService;@Controller@RequestMapping("hello")public class UserController{@Autowired private IUserService hService;@RequestMapping(value="demo1") public String demo1(){ return"demo1";}@SuppressWarnings("deprecation")@RequestMapping(value="demo2") public String demo2(){ return hService.test();}@RequestMapping(value="demo3")@ResponseBody public String demo3(){ User user= new User(); user.setId(1L); user.setEmail("mr_songyang1990@163.com"); user.setPassword("1q2w3e4r,123456,aaaaa"); return hService.getUser(user);}@RequestMapping(value="demo4")@ResponseBody public String demo4(){ User user= new User(); user.setId(1L); user.setEmail("mr_songyang1990@163.com"); user.setPassword("1q2w3e4r,123456,aaaaa"); return hService.getUser2(user);}}

service:

package com.sy.demo.service;import com.sy.demo.entity.User;public interface IUserService{@Deprecated public String test(); public String getUser(User user); public String getUser2(User user);}

package com.sy.demo.service.impl;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Service;import com.sy.demo.entity.User;import com.sy.demo.repository.IUserRepository;import com.sy.demo.service.IUserService;@Service("hService")public class UserServiceImpl implements IUserService{@Autowired private IUserRepository hRepository;@Deprecated@Override public String test(){ return"demo2";}@Override public String getUser(User user){ return hRepository.queryUser(user);}@Override public String getUser2(User user){ return hRepository.queryUser2(user);}}

Repository

package com.sy.demo.repository.impl;import java.sql.PreparedStatement;import java.sql.ResultSet;import java.sql.SQLException;import org.springframework.stereotype.Repository;import com.sy.demo.entity.User;import com.sy.demo.repository.IUserRepository;import com.sy.demo.util.DBUtil;import com.sy.demo.util.SqlUtil;@Repository("hRepository")public class UserRepositoryImpl implements IUserRepository{ public String queryUser(User user){ String sql= SqlUtil.getSql(user); System.out.println(sql); return sql;}@Override public String queryUser2(User user){ StringBuilder sb= new StringBuilder(); String sql= SqlUtil.getSql(user); System.out.println(sql); PreparedStatement ps= DBUtil.getPreparedStatement(sql); Long id; String email; String password; try{ ResultSet rs= ps.executeQuery(); while(rs.next()){ id= rs.getLong("id"); email= rs.getString("email"); password= rs.getString("password"); sb.append("ID:").append(id).append(", email:"). append(email).append(", password:").append(password).append("<br/>");}} catch(SQLException e){ e.printStackTrace();} return sb.toString();}}

entity:

annotation

package com.sy.demo.annotation;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)@Documentedpublic@interface Column{ public String value();}

util工具类

package com.sy.demo.util;import java.sql.Connection;import java.sql.PreparedStatement;import java.sql.SQLException;import com.mysql.jdbc.jdbc2.optional.MysqlDataSource;public class DBUtil{ public static final String URL="jdbc:mysql://localhost:3306/db_test"; public static final String USERNAME="root"; public static final String PASSWORD="root"; public static Connection conn= null; public static MysqlDataSource dataSource; static{ dataSource= new MysqlDataSource(); dataSource.setUser(USERNAME); dataSource.setPassword(PASSWORD); dataSource.setURL(URL);} public static PreparedStatement getPreparedStatement(String sql){ try{ conn= dataSource.getConnection(); return conn.prepareStatement(sql);} catch(SQLException e){ e.printStackTrace();} return null;}}

OK，关于java自定义注解有什么用和java中注释和注解于什么区别啊的内容到此结束了，希望对大家有所帮助。

java试用期什么都不会(java 工作试用期一般多久) 紫砂壶鉴别（紫砂壶鉴别真假方法视频）