18.6.15springboot中关于Bean的注解
本节介绍注解:
@Component
@Service
@Scope
@Repository
@Controller
@RestController
@RequestMapping
@PathVariable
@ResponseBody
如何吸引Spring容器的注意而“有幸”成为Spring 容器管理的Bean呢?
在Spring Boot中就依靠注解。Spring提供了多个注解来声明Bean为Spring容器管理的Bean,注解不同代表的含义不同,但是对Spring容器来说都是Spring管理的Bean。
Spring IoC(ApplicationContext)容器负责进行扫描Bean,进行Bean的初始化、配置和依赖管理。
声明Bean的注解有:
@Component 没有明确角色的组件
@Service 在业务逻辑层(Service层)使用
@Repositpry 在数据访问层(dao层)使用
@Controller 用于标注控制层组件
@RestController
1、@Component注解
/**
- @since 2.5
- @see Repository
- @see Service
- @see Controller
- @see org.springframework.context.annotation.ClassPathBeanDefinitionScanner // 扫描包中Bean,注册
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Indexed
public @interface Component {
// 如果有返回组件名称,否则返回空字符串
String value() default "";
}
@Component注解作用域默认为singleton
@Component使用在不确定哪一个层的时候使用,可以作用在任何层次,把普通pojo实例化到spring容器
不推荐使用@Component注解,而应该使用它的扩展,如@Service、@Repository
2、@Service注解 - @see Component
- @see Repository
*/
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Service {
@AliasFor(annotation = Component.class)
String value() default "";
}
@Service是@Component注解的一个特例,作用在类上
@Service注解作用域默认为singleton
使用注解配置和类路径扫描时,被@Service注解标注的类会被Spring扫描并注册为Bean
@Service用于标注业务层组件,表示定义一个bean
@Service使用时没有传参数,Bean名称默认为当前类的类名,首字母小写
@Service(“serviceBeanId”)或@Service(value=”serviceBeanId”)使用时传参数,使用value作为Bean名字
3、@Scope注解
@Scope有5种取值:
基本作用域:
org.springframework.beans.factory.config.ConfigurableBeanFactory.SCOPE_SINGLETON = "singleton"
Spring 容器中有且只有一个Bean实例,只要Spring容器不销毁或退出,该Bean实例就会一直存活
org.springframework.beans.factory.config.ConfigurableBeanFactory.SCOPE_PROTOTYPE = "prototype"
每次获取Bean的时候会有一个新的实例,Spring容器不能对返回Bean实例的整个生命周期负责
Web作用域:
org.springframework.web.context.WebApplicationContext#SCOPE_REQUEST = "request"
request只适用于Web程序,每一次HTTP请求都会产生一个新的bean,同时该bean仅在当前HTTP request内有效,当请求结束后,该对象的生命周期即告结束
org.springframework.web.context.WebApplicationContext#SCOPE_SESSION = "session"
session只适用于Web程序,session作用域表示该针对每一次HTTP请求都会产生一个新的bean,同时该bean仅在当前HTTP session内有效
org.springframework.web.context.WebApplicationContext#SCOPE_APPLICATION = "application"
application只适用于Web程序,全局作用域
@Scope作用在类上和方法上
@Scope用来配置 spring bean 的作用域,它标识 bean 的作用域
例如:
// 单例
@Service
@Scope("singleton")
public class SingletonScope {
public SingletonScope() {
}
}
//原型
@Service
@Scope("prototype")
public class PrototypeScope {
public PrototypeScope() {
}
}
4、@Repository注解
- @see Component
- @see Service
- @see org.springframework.dao.DataAccessException
- @see org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor
*/
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Repository {
@AliasFor(annotation = Component.class)
String value() default "";
}
@Repository注解默认作用域为singlton,单例
@Repository与@Scope注解一起使用可以修改Bean的作用域
5、@Controller注解 - @see Component
- @see org.springframework.web.bind.annotation.RequestMapping
- @see org.springframework.context.annotation.ClassPathBeanDefinitionScanner
*/
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Controller {
@AliasFor(annotation = Component.class)
String value() default "";
}
@Controller注解作用在类上
使用注解配置和类路径扫描时,被@Controller注解标注的类会被Spring扫描并注册为Bean
@Controller用于标注Web中控制层组件
被@Controller标注的类负责处理由DispatcherServlet分发的请求,它把用户请求的数据经过业务处理层处理之后封装成一个Model ,然后再把该Model返回给对应的View进行展示
@Controller和@RequestMapping、@RequestParam等一些注解共同处理URL的映射
6、@RequestMapping注解
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
String name() default "";
@AliasFor("path")
String[] value() default {};
@AliasFor("value")
String[] path() default {};
RequestMethod[] method() default {};
String[] params() default {};
String[] headers() default {};
String[] consumes() default {};
String[] produces() default {};
}
@RequestMapping注解作用在类或方法上
@RequestMapping注解用来处理请求地址映射
@RequestMapping注解有7个属性
value和path参数method参数 consumes参数produces参数params参数headers参数
@RequestMapping请求路径匹配
符号 * 匹配任一字符
符号 ** 匹配任意路径
符号 ? 匹配单个字符
如果一个请求有多个@Requestmapping能够匹配,通过匹配更具体的方法处理此请求
@RequestMapping注解标注的方法可以接受多种类型的参数:
详细参考书籍:Spring Boot精髓 从构建小系统到架构分布式大系统
@PathVariable - 将URL中的值映射到方法参数中
Model - Spring MVC中通用的模型
ModelAndView - 包含了模型和视图路径的对象
JavaBean - 将HTTP参数映射到JavaBean对象
MultipartFile - 用于处理文件上传
@ModelAttribute - 用于将该注解的变量作为Model的一个属性
7、@ResponseBody注解
@ResponseBody注解支持将返回值放在response体内,而不是返回一个视图
@ResponseBody注解直接将返回的对象输出到客户端
如果返回字符串,直接返回
如果返回不是字符串,默认使用Jackson将对象序列化成JSON字符串后输出
8、@RestController注解/这个挺酷的。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
@AliasFor(annotation = Controller.class)
String value() default "";
}
@RestController是一个组合注解
@RestController = @Controller + @ResponseBody
@RestController注解直接将返回的对象输出到客户端
如果返回字符串,直接返回
如果返回不是字符串,默认使用Jackson将对象序列化成JSON字符串后输出
参考:https://blog.csdn.net/lipinganq/article/details/79155072
——————————————————————
18.6.14
springboot自带tomcat,因此无需配置自己的tomcat,如果想使用自己的tomcat,需要增加<scope>provided</scope>标签,含义是告诉springboot我已经提供了。
如果没有提供tomcat,想要使用springboot自带的tomcat,需要把provided注释。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
——————————————————————
17.12.22
idea新建springboot项目有一个默认目录,页面文件不在放在传统的webapp页面中。
资源文件夹下static文件夹用来存放web程序的静态资源,例如图片、css、js等。
template文件夹存放web程序的视图模板,html等需要渲染的模板文件就放在这里。
application.properties文件很重要,它是Spring Boot项目的全局配置文件。
Spring Boot项目更喜欢Java配置方式。因此从这里开始,所有的Spring配置都是用Java方式配置。
——————————————————————
17.12初
最近在研究springboot。有一本Spring Boot实战 ,丁雪丰 (译者) .pdf。主要部分看了一遍。
学习了一下“自动配置”和“启动依赖”。
具体的以后讲。
然后在网上找了idea搭建springboot的基础教程,搭建自己的springboot。
教程很多,但是很多照着做自己实现的时候就是不行,现实就是这么有意思。
然后通过报错或者log满满排查研究。遇到的问题都写在这里。
1、所有教程都有一个helloword,以下是我的。
@RestController
public class HelloController {
@RequestMapping("/hello")
public String say(){
return "Hello beauty!";
}
}
然后run或debug后跑起来直接关闭了,并没有在后台运行。
解决:pom文件中tomcat依赖,把<scope>provided</scope>。注释了就可以跑起来测试了。
- provided,类似compile,期望JDK、容器或使用者会提供这个依赖。如servlet.jar。
解析:provided的意思是只在编译和测试阶段可用这个包。但是在实际发布阶段则忽略这个包。
使用provided的原因是在编译和测试的时候使用tomcat提供的包,但是将war部署的服务器上的web服务器容器中,就会发生内嵌的tomcat包和web服务器提供的包冲突。所以在编译打包成war部署之前要添加provided,这样就能防止包的冲突。
而如果是自己本地启动,并且没有配置额外的tomcat,使用内嵌的tomcat启动,则需要将provided注释。
——————————————————
网友评论