枚举类和注解

CZ_风

已于 2022-06-28 11:22:54 修改

阅读量223

点赞数

分类专栏： Java编程基础文章标签： java 开发语言青少年编程后端

于 2022-06-21 18:30:24 首次发布

本文链接：https://blog.csdn.net/VastStarsCZFeng/article/details/125362149

版权

Java编程基础专栏收录该内容

8 篇文章 0 订阅

订阅专栏

跟踪代码依赖性，实现替代配置文件功能

自定义Annotation

元注解

枚举类的使用

  1、枚举类的理解：类的对象只有有限个，确定的。我们称此类为枚举类。
  2、当需要定义一组常量时，强烈建议使用枚举类。
  3、如果枚举类中只有一个对象，则可以作为单例模式的实现方式。
  4、枚举类对象的属性不允许被改动，所以应该使用 private final修饰。 
  5、枚举类的使用private final 修饰的属性应该在构造器中为其赋值。
  6、若枚举类显示的定义了带参数的构造器，则在列出枚举值时也应该必须对应的传入参数。

枚举类的实现

JDK 1.5之前需要自定义枚举类。

JDK 1.5新增的 enum 关键字用于定义枚举类。

自定义枚举类

1、对象如果有实例变量，应该声明为 private final，并在构造器中初始化。

2、私有化类的构造器，保证不能在类的外部创建其对象。

3、在类的内部创建枚举类的实例。声明为：public static final

//自定义枚举类

class Season{
    //1、声明Season对象的属性：private final 修饰
    private final String seasonName;
    private final String seasonDesc;

    //2、私有化类的构造器,并给对象属性赋值
    private Season(String seasonName,String seasonDesc){
        this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }
    //3、提供当前枚举类的多个对象
    public static final Season SPRING = new Season("春天","春暖花开");
    public static final Season SUMMER = new Season("夏天","夏日炎炎");
    public static final Season AUTUMN = new Season("秋天","硕果累累");
    public static final Season WINTER = new Season("冬天","白雪皑皑");

    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }

    @Override
    public String toString() {
        return "Season{" +
                "seasonName='" + seasonName + '\'' +
                ", seasonDesc='" + seasonDesc + '\'' +
                '}';
    }
}


//枚举类的使用
public class Test {
    public static void main(String[] args) {
        Season spring = Season.SPRING;
        System.out.println(spring); //Season{seasonName='春天', seasonDesc='春暖花开'}

    }
}

使用 enum 定义枚举类

1、使用 enum 定义的枚举类默认继承了 java.lang.Enum 类，因此不能再继承其他类。

2、枚举类的构造器只能使用 private 权限修饰符。

3、枚举类的所有实例不想在枚举类中显式列出 ( , 分隔 ; 结尾 )。列出的实例系统会自动添加

public static final 修饰。

4、必须在枚举类的第一行声明枚举类对象。

5、JDK 1.5 中可以在 switch 表达式中使用 Enum 定义的枚举类的对象作为表达式，case 子句可以直接使用枚举值的名字，无需添加枚举类作为限定。

6、和普通 Java 类一样，枚举类可以实现一个或多个接口。
7、若每个枚举值在调用实现的接口方法呈现相同的行为方式，则只要统一实现该方法即可。
8、若需要每个枚举值在调用实现的接口方法呈现出不同的行为方式 ,则可以让每个枚举值分别来实现该方法。

Enum 类的主要方法
  values() ：返回枚举类型的对象数组。该方法可以很方便地遍历所有的枚举值。

  valueOf (String str )：可以把一个字符串转为对应的枚举类对象。要求字符串必须是枚举类对象的“名字”。如不是，会有 运行 时异常：IllegalArgumentException 。

  toString()：返回当前枚举类对象常量的名称。

//使用enum关键字定义枚举类

enum Season{
    //1、提供当前枚举类的多个对象,多个对象之间用","隔开，末尾对象";"结束
    SPRING("春天","春暖花开"),
    SUMMER("夏天","夏日炎炎"),
    AUTUMN("秋天","硕果累累"),
    WINTER("冬天","白雪皑皑");

    //2、声明Season对象的属性：private final 修饰
    private final String seasonName;
    private final String seasonDesc;

    //3、私有化类的构造器,并给对象属性赋值
    private Season1(String seasonName,String seasonDesc){
        this.seasonName = seasonName;
        this.seasonDesc = seasonDesc;
    }

    public String getSeasonName() {
        return seasonName;
    }

    public String getSeasonDesc() {
        return seasonDesc;
    }
}


//枚举类的使用
public class Test {
    public static void main(String[] args) {
        Season spring = Season.SPRING;
        //toString()
        System.out.println(spring.toString()); //SPRING

        //values()
        Season[] values = Season.values();
        for (int i = 0; i < values.length; i++) {
            System.out.println(values[i]);
        }

        //valueOf(String objName):返回枚举类中对象名是objName的对象，如果没有objName的枚举类对象抛异常
        Season winter = Season.valueOf("WINTER");
        System.out.println(winter); //WINTER

    }
}

注解Annotation

概述

● 从 JDK 5.0 开始 , Java 增加了对元数据 MetaData ) 的支持 , 也就是Annotation( 注解）。
● Annotation 其实就是代码里的特殊标记 , 这些标记可以在编译 , 类加载 , 运行时被读取 , 并执行相应的处理。通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下 , 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行署。
● Annotation 可以像修饰符一样被使用 , 可用于修饰包类 , 构造器 , 方法 , 成员变量 , 参数 , 局部变量的声明 , 这些信息被保存在 Annotation的 “name=value” 对中。

● 在 JavaSE 中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android 中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替 JavaEE 旧版中所遗留的繁冗代码和 XML 配置等。
● 未来的开发模式都是基于注解的， JPA 是基于注解的， Spring2.5 以上都是基于注解的， Hibernate3.x 以后也是基于注解的，现在的Struts2 有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说： 框架 = 注解 + 反射 + 设计模式。

● 使用 Annotation 时要在其前面增加 @ 符号 , 并把该 Annotation 当成一个修饰符使用。用于修饰它支持的程序元素。

常见的Annotation

生成文档相关的注解

@author  标明开发该类模块的作者，多个作者之间使用，分割。
@version  标明该类模块的版本。
@see 参考转向，也就是相关主题。
@since 从哪个版本开始增加的。
@param 对方法中某参数的说明，如果没有参数就不能写。
@return  对方法返回值的说明，如果方法的返回值类型是 void 就不能写。
@exception 对方法可能抛出的异常进行说明，如果方法没有用 throws 显式抛出的异常就不能写。

        @param @return 和 @exception 这三个标记都是只用于方法的。
        @param 的格式要求：@param 形参名形参类型形参说明。
        @return 的格式要求：@return 返回值类型返回值说明。
        @exception 的格式要求：@exception 异常类型异常说明。
        @param 和 @exception 可以并列多个。

/**
 * @author 六六六
 * @version 1.0
 * @see Math
 */
public class JavadocTest {
    /**
     * 程序的主方法，程序的入口
     * @param args String[] 命令行参数
     */
    public static void main(String[] args) {

    }

    /**
     * 求成功的方法
     * @param result boolean 期望
     * @return boolean 结果
     */
    public static boolean getSuccess(boolean result){
        return result;
    }
}

在编译时进行格式检查

        @Override：限定重写父类方法 , 该注解只能用于方法。
        @Deprecated：用于表示所修饰的元素类 , 方法等已过时。通常是因为所修饰的结构危险或存在更好的选择
        @SuppressWarnings：抑制编译器警告。

public class Test{
    public static void main(String[] args) {
        @SuppressWarnings("unused")
        int a = 666;
    }
    
    @Deprecated
    public void print(){
        System.out.println("过时的方法");
    }
    
    @Override
    public String toString(){
        return "重写的toString方法";
    }
}

跟踪代码依赖性，实现替代配置文件功能


//Servlet3.0提供了注解（annotation），使得不再需要在web.xml文件中进行Servlet的部署

@WebServlet("/login")
public class LoginServlet extends HttpServlet{
    private static final long serialVersionUID = 6L;
    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 框架中关于“事务”的管理
@Transaction(propagation = Propagation.REQUIRES_NEW,
             isolation = Isolation.RED_COMMITTED, readOnly = false, timeout = 3)
public void buyBook(String username, String isbn){
    //查询书的单价
    int price = bookShopDao.findBookPriceByIsbn(isbn);
    //更新库存
    bookShopDao.updateBookStock(isbn);
    //更新用户的余额
    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>

自定义Annotation

● 定义新的 Annotation 类型使用 @interface 关键字。
     ● 自定义注解自动继承了 java.lang.annotation.Annotation 接口。
● Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。 类型只能是八种基本数据类型、 String 类型、 Class 类型、 enum 类型、 Annotation 类型、以上所有类型的数组。
     ● 可以在定义 Annotation 的成员变量时为其指定初始值，指定成员变量的初始值可使用 default 关键字。
     ● 如果只有一个参数成员，建议使用参数名为 value
     ● 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名 = 参数值 ”如果只有一个参数成员，且名称为 value，可以省略“value=”
● 没有成员定义的 Annotation 称为标记；包含成员变量的 Annotation 称为元数据 Annotation。
     ● 自定义注解必须配上注解的信息处理流程（使用反射）才有意义。


@MyAnnotation(value="有点六")
public class MyAnnotationTest{
    public static void main(String[] args){
        Class c = MyAnnotationTest.class;
        Annotation a = c.getAnnotation(MyAnnotation.class);
        MyAnnotation m = (MyAnnotation)a;
        String info = m.value();
        System.out.println(info);
    }
}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface MyAnnotation{
    String value() default "nicesix";
}

元注解

元注解（meta-annotation)：对现有的注解进行解释说明的注解。

Retention

Target

Documented

Inherited

        @Retention : 只能用于修饰一个 Annotation 定义 , 用于指定该 Annotation 的生命周期 ,              @Rentention 包含一个 RetentionPolicy 类型的成员变量 , 使用@Rentention 时必须为该 value 成员变量指定值：
RetentionPolicy.SOURCE：在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释。
                RetentionPolicy.CLASS：在 class 文件中有效（即 class 保留），当运行 Java 程序时，JVM不会保留注解。这是默认值。
                RetentionPolicy.RUNTIME：在运行时有效（即运行时保留）当运行 Java 程序时 , JVM 会保留注释。程序可以通过反射获取该注释。


@Retention(RetentionPolicy.SOURCE)
@interface MyAnnotation{   }

@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation1{   }

@Target : 用于修饰 Annotation 定义 , 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。

取值		取值
CONSTRUCTOR	用于描述构造器	PACKAGE	用于描述包
FIELD	用于描述域	PARAMETER	用于描述参数
LOCAL_VARIABLE	用于描述局部变量	TYPE	用于描述类、接口（包括注解类型）或enum声明
METHOD	用于描述方法

@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下 javadoc 是不包括注解的。
定义为 Documented 的注解必须设置 Retention 值为 RUNTIME 。

@Inherited: 被它修饰的 Annotation 将具有继承性 。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。
比如：如果把标有 @Inherited 注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解。实际应用中，使用较少。

@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {

    String value() default "hello";
}

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
public @interface MyAnnotations {

    MyAnnotation[] value();
}

通过反射来进行获取、调用注解信息。
前提：要求此注解的元注解Retention中声明的生命周期状态为：RUNTIME.

JDK8中注解的新特性：可重复注解、类型注解

        可重复注解：

               ① 在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class
② MyAnnotation的Target和Retention等元注解与MyAnnotations相同。

        类型注解：
                ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中（如：泛型声明。）
                ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。

CZ_风

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
枚举类和注解

1、枚举类的理解：类的对象只有有限个，确定的。我们称此类为枚举类。 2、当需要定义一组常量时，强烈建议使用枚举类。 3、如果枚举类中只有一个对象，则可以作为单例模式的实现方式。 4、枚举类对象的属性不允许被改动，所以应该使用 private final修饰。 5、枚举类的使用private final 修饰的属性应该在构造器中为其赋值。 6、若枚举类显示的定义了带参数的构造器，则在列出枚举值时也应该必须对应的传入参数。枚举类的实现 JDK 1.5之前需要自定义枚举类。
复制链接

扫一扫