尚硅谷JavaSE课程进阶第8章之注解Annotation
注解的概述
1、Annotation的作用
- 注解不是程序本身，可以对程序作出解释。（这一点，跟注释没什么区别）
- 可以被其他程序（比如：编译器，Checker Framework等）读取。（注解信息处理流程，是注解和注释的重大区别。如果没有注解信息处理流程，则注解毫无意义）
2、Annotation的格式
注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value=”unchecked”)
3、Annotation在哪里使用
Annotation 可以像修饰符一样被使用, 可用于修饰包，类, 构造器, 方法, 成员变量, 参数, 局部变量。相当于给它们添加了额外的辅助信息，而且有些注解我们可以通过反射机制编程实现对这些元数据的访问。
常见的注解示例
1、生成文档
@author 标明开发该类模块的作者，多个作者之间使用,分割
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@since 从哪个版本开始增加的
@param 对方法中某参数的说明，如果没有参数就不能写
@return 对方法返回值的说明，如果方法的返回值类型是void就不能写
@exception 对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常就不能写
其中 @param @return 和 @exception 这三个标记都是只用于方法的。
@param的格式要求：@param 形参名 形参类型 形参说明
@return 的格式要求：@return 返回值类型 返回值说明
@exception的格式要求：@exception 异常类型 异常说明
@param和@exception可以并列多个
javadoc.exe就是这些注解的信息处理流程
|
package com.annotation.javadoc; /** * * @author Irene * @version 1.0 * @see Math.java * */ public class TestJavadoc {
/** * 程序的主方法，程序的入口 * @param args String[] 命令行参数 */ public static void main(String[] args) { }
/** * 求圆面积的方法 * @param radius double 半径值 * @return double 圆的面积 */ public static double getArea(double radius){ return Math.PI * radius * radius; } }
|
2、在编译时进行格式检查
JDK中系统内置了常用的三个注解：
（1）@Override：按照重写的要求检查方法的格式
（2）@Deprecated：过时，表示不鼓励程序员使用这样的元素，因为存在危险或有更好的实现
（3）@SuppressWarnings：抑制警告
|
package com.annotation.javadoc;
public class TestAnnotation {
public static void main(String[] args) { @SuppressWarnings("unused") int a = 10; } @Deprecated public void print(){ System.out.println("过时的方法"); }
@Override public String toString() { return "重写的toString方法()"; } } |
3、跟踪代码依赖性，实现替代配置文件功能
Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署
|
package com.servlet;
import java.io.IOException; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse;
@WebServlet("/login") public class LoginServlet extends HttpServlet { private static final long serialVersionUID = 1L;
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { }
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); } } |
|
<servlet> <servlet-name>LoginServlet</servlet-name> <servlet-class>com.servlet.LoginServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>LoginServlet</servlet-name> <url-pattern>/login</url-pattern> </servlet-mapping> |
spring框架中关于“事务”的管理
|
@Transactional(propagation=Propagation.REQUIRES_NEW, isolation=Isolation.READ_COMMITTED, readOnly=false, timeout=3) public void buyBook(String username, String isbn) { //1.查询书的单价 int price = bookShopDao.findBookPriceByIsbn(isbn); //2. 更新库存 bookShopDao.updateBookStock(isbn); //3. 更新用户的余额 bookShopDao.updateUserAccount(username, price); } |
|
<!-- 配置事务属性 --> <tx:advice transaction-manager="dataSourceTransactionManager" id="txAdvice"> <tx:attributes> <!-- 配置每个方法使用的事务属性 --> <tx:method name="buyBook" propagation="REQUIRES_NEW" isolation="READ_COMMITTED" read-only="false" timeout="3" /> </tx:attributes> </tx:advice> |
4、JUnit框架中的注解
JUnit是由 Erich Gamma 和 Kent Beck 编写的一个回归测试框架（regression testing framework）,供Java开发人员编写单元测试之用。多数Java的开发环境都已经集成了JUnit作为单元测试的工具。
Junit测试是程序员测试，即所谓白盒测试，因为程序员知道被测试的软件如何（How）完成功能和完成什么样（What）的功能。
如何使用JUnit
要使用JUnit，必须在项目的编译路径中必须引入JUnit的库，即相关的.class文件组成的jar包。
如何把JUnit的jar添加到编译路径如图所示：
JUnit的常用注解
使用JUnit测试的类必须是public的。
JUnit4常见的注解和要求：这些方法都必须是public，无参，无返回值。
@Test：标记在非静态的测试方法上。只有标记@Test的方法才能被作为一个测试方法单独测试。一个类中可以有多个@Test标记的方法。运行时如果只想运行其中一个@Test标记的方法，那么选择这个方法名，然后单独运行，否则整个类的所有标记了@Test的方法都会被执行。
@Test(timeout=1000)：设置超时时间，如果测试时间超过了你定义的timeout，测试失败
@Test(expected)： 申明出会发生的异常，比如 @Test（expected = Exception.class）
了解：
@BeforeClass：标记在静态方法上。因为这个方法只执行一次。在类初始化时执行。
@AfterClass：标记在静态方法上。因为这个方法只执行一次。在所有方法完成后执行。
@Before：标记在非静态方法上。在@Test方法前面执行，而且是在每一个@Test方法前面都执行
@After：标记在非静态方法上。在@Test方法后面执行，而且是在每一个@Test方法后面都执行
@Ignore：标记在本次不参与测试的方法上。这个注解的含义就是“某些方法尚未完成，暂不参与此次测试”。
@BeforeClass、@AfterClass、@Before、@After、@Ignore都是配合@Test它使用的，单独使用没有意义。
|
import org.junit.After; import org.junit.AfterClass; import org.junit.Before; import org.junit.BeforeClass; import org.junit.Test;
public class TestJUnit2 { private static Object[] array; private static int total;
@BeforeClass public static void init(){ System.out.println("初始化数组"); array = new Object[5]; }
@Before public void before(){ System.out.println("调用之前total=" + total); }
@Test public void add(){ //往数组中存储一个元素 System.out.println("add"); array[total++] = "hello"; }
@After public void after(){ System.out.println("调用之前total=" + total); }
@AfterClass public static void destroy(){ array = null; System.out.println("销毁数组"); } } |
如何运行Junit测试方法
一个类中可以有多个@Test标记的方法，运行时如果只想运行其中一个@Test标记的方法，那么选择这个方法名，然后单独运行，否则整个类的所有标记了@Test的方法都会被执行。
