美文网首页
spring-boot 注解

spring-boot 注解

作者: xjw_2048 | 来源:发表于2017-09-15 16:07 被阅读0次

spring-boot使用了大量的注解来进行开发,

Application类,是spring-boot的启动类,

@SpringBootApplication 申明让spring boot自动给程序进行必要的配置等同于:@Configuration ,@EnableAutoConfiguration 和 @ComponentScan 三个配置。其中@ComponentScan让spring Boot扫描到Configuration类并把它加入到程序上下文。

@SpringBootApplication

public class FeedApplication {

public static void main(String[] args) {

SpringApplication.run(FeedApplication.class, args);

}

}

SpringApplication.run(FeedApplication.class, args);

该方法就是用来启动项目的。

@Configuration 等同于spring的XML配置文件;使用Java代码可以检查类型安全。

示例代码:

@Configuration

@PropertySource("classpath:/database.properties")

public class DataBaseConfig {

@Bean

@ConfigurationProperties(prefix = "notice.datasource")

public DataSource noticeDataSource() {

return DataSourceBuilder.create().build();

}

@Bean

public JdbcTemplate noticeJDBCTemplate() {

return new JdbcTemplate(noticeDataSource());

}

}

这个就是用来配置数据库的配置。添加@Configuration 以后, spring-boot启动的时候,就会自动识别这个使用配置文件,然后就会自动加载配置。

@PropertySource("classpath:/database.properties")这个是用来定于配置文件的位置,如果没有添加这个注解的话,就会默认去application.ConfigurationPropertie中进行查找。

@Controller:用于定义控制器类,在spring 项目中由控制器负责将用户发来的

URL请求转发到对应的服务接口(service层),一般这个注解在类中,

通常方法需要配合注解@RequestMapping(提供路由信息,负责URL到Controller

中的具体函数的映射)。

示例代码:

@Controller

@RequestMapping("/feed/notice")

public class FeedController {

@Autowired ()

private FeedGetService feedGetService;

@Autowired

private FeedPublishService publishService;

/**

* 获取用户的个人消息以及系统消息的条数

*/

@RequestMapping("/getNoticeNum")

@ResponseBody

public Object getNoticeNum(@RequestParam final String user, @RequestParam final String locale,

@RequestParam final String area, @RequestParam final String channel,

@RequestParam final String version) {

GetUserNoticeNum userNoticeNum = feedGetService.getNoticeNum(user, locale, area, channel, version);

return new ResponseResult<>(userNoticeNum).success();

}

}

@EnableAutoConfiguration 自动配置。

Spring Boot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的

Spring 应用。例如,如果你的classpath下存在HSQLDB,

并且你没有手动配置任何数据库连接beans,

那么我们将自动配置一个内存型(in-memory)数据库”。

你可以将@EnableAutoConfiguration 或者@SpringBootApplication

注解添加到一个@Configuration 类上来选择自动配置。如果发现应用了你

不想要的特定自动配置类,你可以使用@EnableAutoConfiguration

注解的排除属性来禁用它们

@ComponentScan 组件扫描,可自动发现和装配一些Bean。

表示将该类自动发现扫描组件。如果扫描到有@Component、@Controller、@Service 等这些注解的类,并注册为Bean,

可以自动收集所有的Spring组件,包括@Configuration类。

我们经常使用@ComponentScan 注解搜索beans,并结合@Autowired 注解导入。

如果没有配置的话,Spring Boot 会扫描启动类所在包下以及子

包下的使用了@Service,@Repository 等注解的类。(我的项目中就没有进行配置。)

@Component 可配合CommandLineRunner使用,在程序启动后执行一些基础任务。

@RestController 注解是 @Controller 和 @ResponseBody 的合集,

表示这是个控制器bean,并且是将函数的返回值直

接填入HTTP响应体中,是REST风格的控制器。

@Autowired:自动导入依赖的bean 。把配置好的Bean拿来用,完成属性、方法的组装,

它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。

当加上(required=false)时,就算找不到bean也不报错。

@Component:泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。

@Service:一般用于修饰service层的组件

@Bean:用@Bean 标注方法等价于XML中配置的bean。放在方法的上面,而不是类,

意思是产生一个bean,并交给spring管理。

@PathVariable 获取参数。

@Value:注入Spring boot application.properties配置的属性的值。

示例代码:

@Value("${send.sms.byecomm}")

private String sendSMSByEcomm;

application.properties配置文件中配置的是 send.sms.byecomm=http://iran.java.dicepay

spring boot 就会自动将值赋给sendSMSByEcomm,我们调用sendSMSByEcomm就可以了。

@Repository:使用@Repository 注解可以确保DAO或者repositories 提供异常转译,

这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置,

同时也不需要为它们提供XML配置项。

示例代码:

@Repository

public class FeedRedisDao {

@Resource

private StringRedisTemplate feedRedisTemplate;

public void setGetSysNotice(String user, int noticeId, int day) {

String key = "getSysNotice_" + user + "_" + noticeId;

feedRedisTemplate.opsForValue().set(key, user, day, TimeUnit.DAYS);

}

}

@Qualifier:当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。

与@Autowired 配合使用。@Qualifier 限定描述符除了能根据名字进行注入,

但能进行更细粒度的控制如何选择候选者,具体使用方式如下:

示例代码:

@Configuration

@PropertySource("classpath:/database.properties")

public class DataBaseConfig {

@Bean(name = "npsDataSource")

@Primary

@ConfigurationProperties(prefix = "integration.datasource")

public DataSource npsDataSource() {

return DataSourceBuilder.create().build();

}

@Bean(name = "npsJDBCTemplate")

public JdbcTemplate npsJDBCTemplate(@Qualifier("npsDataSource") DataSource npsDataSource) {

return new JdbcTemplate(npsDataSource);

}

@Bean(name = "iranDataSource")

@ConfigurationProperties(prefix = "iran.datasource")

public DataSource iranDataSource() {

return DataSourceBuilder.create().build();

}

@Bean(name = "iranJDBCTemplate")

public JdbcTemplate iranJDBCTemplate(@Qualifier("iranDataSource") DataSource iranDataSource) {

return new JdbcTemplate(iranDataSource);

}

}

示例代码中展示的是两个数据的配置,为了能让数据库加载正确,所以每一个bean都定义了名称。

spring-boot启动的时候会默认加载一个数据库配置,但是配置两个的时候spring-boot

就会不知道该加载那个数据库而报错,所以需要@Primary 注解,@Primary 表示默认加载

哪一个配置。这样在启动的时候就会默认加载npsDataSource这个数据库,然后当你使用iranDataSource

的时候就会自动加载进来,

@Resource(name=”name”,type=”type”):与@Autowired 干类似的事

对于spring-boot 的配置文件有.yml和.properties两种,

.yml的写法

server:

port: 8080

address: localhost

iran:

datasource:

url: dbc:mysql://localhost:3306/asset

username: root

password: root

.properties的写法

server.port=8080

iran.datasource.url=jdbc:mysql://localhost:3306/asset

iran.datasource.username=root

iran.datasource.password=root

相关文章

网友评论

      本文标题:spring-boot 注解

      本文链接:https://www.haomeiwen.com/subject/syejsxtx.html