Spring boot 常用注解

注解是什么

Annotation(注解)是JDK1.5及以后版本引入的，注解是以‘@注解名’在代码中存在的，是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能，当然注解不会也不能影响代码的实际逻辑，仅仅起到辅助性的作用。

常用注解

@Service：注解在类上，表示这是一个业务层bean

package com.example.demo.service;
import org.springframework.stereotype.Service;
//如果有多个类继承UserService 接口则需要用第一个注解指定不同的名字
//@Service("userService")
@Service
public class UserServiceImpl implements UserService{
...
}

@Controller：注解在类上，表示这是一个控制层bean

package com.example.demo.controller;
import org.springframework.stereotype.Controller;
@Controller
public class UserController {
...
}

@Repository：注解在类上，表示这是一个数据访问层bean
@Component：注解在类上，表示这是一个组件bean

@Autowired：按类型装配
@Resource： 按名称装配

package com.example.demo.controller;
import com.example.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;

@Controller
public class UserController {
    //自动把UserService 接口的实现类实例化给userService变量
    @Autowired

    //如果有多个类实现了UserService接口，则我们需要按名注入
    //则要结合@Qualifier("userService1") 注解装载指定的实现类
    //@Qualifier("userService1")

    //@Autowired +  @Qualifier = @Resource
    //@Resource(name = "userService1")
    private UserService userService;

}

说明： @Autowired属于Spring的；@Resource为JSR-250标准的注释，属于J2EE的。
@Autowired默认按类型装配，默认情况下必须要求依赖对象必须存在，如果要允许null 值，可以设置它的required属性为false，如：@Autowired(required=false) ，如果我们想使用名称装配可以结合@Qualifier注解进行使用

@Configuration：注解在类上，表示这是一个IOC容器，相当于spring的配置文件，java配置的方式。 IOC容器的配置类
@Bean： 注解在方法上，声明当前方法返回一个Bean

@Configuration    
public class ExampleConfiguration {    
    
    @Value("com.mysql.jdbc.Driver")    
    private String driverClassName;    
    
    @Value("jdbc://xxxx.xx.xxx/xx")    
    private String driverUrl;    
    
    @Value("${root}")    
    private String driverUsername;    
    
    @Value("123456")    
    private String driverPassword;    
    
    @Bean(name = "dataSource")    
    public DataSource dataSource() {    
        BasicDataSource dataSource = new BasicDataSource();    
        dataSource.setDriverClassName(driverClassName);    
        dataSource.setUrl(driverUrl);    
        dataSource.setUsername(driverUsername);    
        dataSource.setPassword(driverPassword);    
        return dataSource;    
    }    
    
    @Bean    
    public PlatformTransactionManager transactionManager() {    
        return new DataSourceTransactionManager(dataSource());    
    }

使用

//这个dataSource就是我们在ExampleConfiguration中配的DataSource
@Autowired
private DataSource dataSource;

说明：
@Configuration可理解为用spring的时候xml里面的<beans>标签
@Bean可理解为用spring的时候xml里面的<bean>标签

@PostConstruct：注解在方法上，构造函数执行后执行。
@PreDestroy： 注解在方法上，在Bean销毁前执行。
@ComponentScan：注解在类上，扫描标注了@Controller等注解的类，注册为bean

@Lazy(true)：延迟初始化
可以解决循环依赖，首先说一下什么是依赖循环，比如：我现在有一个ServiceA需要调用ServiceB的方法，那么ServiceA就依赖于ServiceB，那在ServiceB中再调用ServiceA的方法，就形成了循环依赖。Spring在初始化bean的时候就不知道先初始化哪个bean就会报错。代码如下：

public class ClassA {  
    @Autowired  
    @Lazy   //如果不加就会报错
    ClassB classB;  
}  
  
public class ClassB {  
    @Autowired  
    @Lazy  //如果不加就会报错
    ClassA classA ;  
}

当然循环依赖在项目中尽量避免

@Scope：注解在类上，描述spring容器如何创建Bean实例。
Scope描述的是Spring容器如何新建Bean实例的。Spring的Scope有以下几种，通过@Scope注解来实现。

  • singleton：一个Spring容器中只有一个Bean的实例，此为Spring的默认配置，全容器共享一个实例。
  • prototype：每次调用新建一个Bean实例。
  • request：Web项目中，给每一个 http request 新建一个Bean实例。
  • session：Web项目中，给每一个 http session 新建一个Bean实例。
  • globalSession：这个只在portal应用中有用，给每一个 global http session 新建一个Bean实例。
package com.example.demo.config;
import org.springframework.context.annotation.Scope;

@Scope("singleton")
public class DataSourceConfig {
...
}

@Value：注解在变量上，从配置文件中读取。
application.properties 文件

server.port=8080
debug=true

# DataSource
spring.datasource.url=jdbc:mysql://localhost:3306/test？characterEncoding=utf-8&useSSL=false&serverTimezone=UTC 
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# JPA
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=update

测试代码

@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {
    
    //读取application.properties 文件spring.datasource.url 这个内容 
    @Value("${spring.datasource.url}")
    private String dataSourceURL;
}

@Profile：注解在方法 类上 在不同情况下选择实例化不同的Bean 特定环境下生效

public interface DBConnector {
    public void configure();    
}

//测试数据库
@Component
@Profile("testdb")
public class TestDBConnector implements DBConnector {
    @Override
    public void configure() {
        System.out.println("testdb");
    }
}

// 生产数据库
@Component
@Profile("devdb")
public class DevDBConnector implements DBConnector {
    @Override
    public void configure() {
        System.out.println("devdb");
    }
}

application.properties

spring.profiles.active=testdb

测试

@RestController
@RequestMapping("/task")
public class TaskController {
    @Autowired 
    DBConnector connector ;
    @RequestMapping(value = {"/",""})
    public String hellTask(){

        connector.configure(); //最终打印testdb     
        return "hello task !! myage is " + myage;
    }

}

@SpringBootApplication：@SpringBootApplication=@ComponentScan+@Configuration+@EnableAutoConfiguration：约定优于配置

@WebServlet(name="Servlet3FirstDemo",value="/Servlet3FirstDemo")
@WebFilter将一个实现了javax.servlet.Filte接口的类定义为过滤器

第三方servlet:使用ServletRegistrationBean来注入servlet，对于每一个servlet都有一个ServletRegistrationBean来注入。

@RestController = @RestController + @ResponseBody + @Controller

@RequestBody
@RequestBody 注解则是将 HTTP 请求正文插入方法中，使用适合的 HttpMessageConverter 将请求体写入某个对象。
JAVA

@RequestMapping(value = "user/login")
@ResponseBody
// 将ajax（datas）发出的请求写入 User 对象中,返回json对象响应回去
public User login(User user) {   
    User user = new User();
    user.setUserid(1);
    user.setUsername("MrF");
    user.setStatus("1");
    return user ;
}

function login() {
    var datas = '{"username":"' + $('#username').val() + '",
    "userid":"' + $('#userid').val() + '",
    "status":"' + $('#status').val() + '"}';
    $.ajax({
        type : 'POST',
        contentType : 'application/json',
        url : "${pageContext.request.contextPath}/user/login",
        processData : false,
        dataType : 'json',
        data : datas,
        success : function(data) {
            alert("userid: " + data.userid + 
                  "username: " + data.username +
                  "status: "+ data.status);
        },
        error : function(XMLHttpRequest, textStatus, errorThrown) {
            alert("出现异常，异常信息："+textStatus,"error");
        }
    });
};

@PathVariable：映射 URL 绑定的占位符

  • 带占位符的 URL 是 Spring3.0 新增的功能，该功能在SpringMVC 向 REST 目标挺进发展过程中具有里程碑的意义
  • 通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中：URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的入参中。
//@PathVariable可以用来映射URL中的占位符到目标方法的参数中
@RequestMapping("/testPathVariable/{id}")
public String testPathVariable(@PathVariable("id") Integer id){
        System.out.println("testPathVariable:"+id);
        return SUCCESS;
}

@RequestMapping
@RequestMapping 是 Spring Web 应用程序中最常被用到的注解之一。这个注解会将 HTTP 请求映射到 MVC 和 REST 控制器的处理方法上。

下面是一个同时在类和方法上应用了 @RequestMapping 注解的示例：

@RestController
@RequestMapping("/home")
public class IndexController {
    @RequestMapping("/")
    String get() {
        //mapped to hostname:port/home/
        return "Hello from get";
    }
    @RequestMapping("/index")
    String index() {
        //mapped to hostname:port/home/index/
        return "Hello from index";
    }
}

如上述代码所示，到 /home 的请求会由 get() 方法来处理，而到 /home/index 的请求会由 index() 来处理。

详细的RequestMapping请参见这边文章：https://www.oschina.net/translate/using-the-spring-requestmapping-annotation

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 202,607评论 5赞 476
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,047评论 2赞 379
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 149,496评论 0赞 335
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,405评论 1赞 273
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,400评论 5赞 364
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,479评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,883评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,535评论 0赞 256
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,743评论 1赞 295
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,544评论 2赞 319
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,612评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,309评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,881评论 3赞 306
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,891评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,136评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,783评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,316评论 2赞 342

推荐阅读更多精彩内容

  • Spring boot参考指南
    Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,717评论 6赞 342
  • Spring Boot常用注解
    注解速览 配置加载相关 Bean 声明注解 Bean 注入注解 SpringMVC 注解 MyBatis 注解 配...
    无芽土豆阅读 1,256评论 0赞 51
  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 134,579评论 18赞 139
  • Spring Boot常用注解小结
    在Spring boot中，注解使用非常频繁，通过使用注解可以有效的提供开发效率，让项目代码看起来更简洁。 之前做...
    弈阁阅读 8,006评论 6赞 93
  • 艺术基础知识
    电影篇
    ZQW97阅读 245评论 0赞 0