微服务常用注解详解

最新推荐文章于 2022-06-27 16:36:16 发布

筱_智

最新推荐文章于 2022-06-27 16:36:16 发布

阅读量1.1k

点赞数

分类专栏：微服务文章标签：注解微服务 @LoadBalanced @SpringBootApplication

本文链接：https://blog.csdn.net/pojpoj/article/details/92831297

版权

微服务专栏收录该内容

5 篇文章 0 订阅

订阅专栏

在介绍微服务注解前，我们先来回顾一下java的元注解：
1、元注解：注解的注解
在java1.6中，有四个元注解：@Target、@Retention、@Documented、@Inherited。在java1.8上，又多了@Native、@Repeatable。

（1）、@Documented:
　　@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。被这个注解注解的注解（真拗口…）会在自动生成api文档时加载文档中。

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField"; 
    public boolean defaultDBValue() default false;
}

（2）、@Inherited：
　　@Inherited 元注解是一个标记注解， @Inherited阐述了某个被标注的类型是被继承的。 如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。
　　注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。
　　当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

/**
 * 
 * @author peida
 *
 */
@Inherited
public @interface Greeting {
    public enum FontColor{ BULE,RED,GREEN};
    String name();
    FontColor fontColor() default FontColor.GREEN;
}

（3）、@Retention：
　　@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
　　作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）
　　取值（RetentionPoicy）有：

1.SOURCE:在源文件中有效（即源文件保留）
2.CLASS:在class文件中有效（即class保留）
3.RUNTIME:在运行时有效（即运行时保留）

Retention meta-annotation类型有唯一的value作为成员，它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。具体实例如下：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField"; 
    public boolean defaultDBValue() default false;
}

Column注解的的RetentionPolicy的属性值是RUTIME,这样注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理。
　　
（4）、@Target：
　　　@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。
　　取值(ElementType)有：

1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）

@Target(ElementType.TYPE)
public @interface Table {
    /**
     * 数据表名称注解，默认值为类名称
     * @return
     */
    public String tableName() default "className";
}

@Target(ElementType.FIELD)
public @interface NoDBColumn {

}

注解Table 可以用于注解类、接口(包括注解类型) 或enum声明,而注解NoDBColumn仅可用于注解类的成员变量。
————————————————————————华丽的分割线————————————————————————
2、@SpringBootApplication 是一个复合注解，
包括@ComponentScan，和@SpringBootConfiguration，@EnableAutoConfiguration

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
... ...
}

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
}

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {
}

@SpringBootConfiguration

@SpringBootConfiguration继承自@Configuration，二者功能也一致，标注当前类是配置类，并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到spring容器中，并且实例名就是方法名。作用为：配置spring容器(应用上下文)

@Configuration
从Spring3.0，@Configuration用于定义配置类，可替换xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描，并用于构建bean定义，初始化Spring容器。

spring @component的作用详细介绍
1、@controller 控制器（注入服务）
2、@service 服务（注入dao）
3、@repository dao（实现dao访问）
4、@component （把普通pojo实例化到spring容器中，相当于配置文件中的）

@Component,@Service,@Controller,@Repository注解的类，并把这些类纳入进spring容器中管理。
下面写这个是引入component的扫描组件

<context:component-scan base-package=”com.jhz”>

其中base-package为需要扫描的包（含所有子包）

1、@Service用于标注业务层组件
2、@Controller用于标注控制层组件(如struts中的action)
3、@Repository用于标注数据访问组件，即DAO组件.
4、@Component泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

3、@EnableConfigurationProperties：使用分布式配置时请启用
先说作用：
@EnableConfigurationProperties注解的作用是：是使用 @ConfigurationProperties 注解的类生效。
说明：
如果一个配置类只配置@ConfigurationProperties注解，而没有使用@Component，那么在IOC容器中是获取不到properties 配置文件转化的bean。说白了 @EnableConfigurationProperties 相当于把使用 @ConfigurationProperties 的类进行了一次注入.。
代码实例参考：https://www.jianshu.com/p/7f54da1cb2eb

@ConfigurationProperties 注解支持两种方式.
加在类上,需要和@Component注解,结合使用.代码如下:
1、
@Component
@ConfigurationProperties(prefix = “com.example.demo”)
2、
通过@Bean的方式进行声明
@Bean
@ConfigurationProperties(prefix = “com.example.demo”)
理解源码参考链接：https://blog.csdn.net/u011649691/article/details/79491674
4、@EnableScheduling ：spring自带的定时任务功能

5、@LoadBalanced
Spring Cloud的commons模块提供了一个@LoadBalanced注解，方便我们对RestTemplate添加一个LoadBalancerClient，以实现客户端负载均衡。通过源码可以发现这是一个标记注解：
Spring Cloud的@LoadBalanced注解让我们可以很容易的通过ribbon实现客户端的负载均衡功能。
Spring Cloud默认使用的是ZoneAwareLoadBalancer。
理解源码参考链接：https://blog.csdn.net/Tincox/article/details/79210309

筱_智

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
1
评论
微服务常用注解详解

在介绍微服务注解前，我们先来回顾一下java的元注解：1、元注解：注解的注解在java1.6中，有四个元注解：@Target、@Retention、@Documented、@Inherited。在java1.8上，又多了@Native、@Repeatable。（1）、@Documented:　　@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共AP...
复制链接

扫一扫