| java, spring, spring-boot

spring-boot

spring & spring boot 注解汇总 及 说明 xXx

@SpringBootApplication:

包含@Configuration、@EnableAutoConfiguration、@ComponentScan
通常用在主类上。

1
2
3
4
5
6
7
8
9
10
/**
 * quick start
 */
@SpringBootApplication
public class Application extends SpringBootServletInitializer{
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

@Repository:

用于标注数据访问组件，即DAO组件。

1
2
3
@Repository  
public class VentorDaoImpl implements iVentorDao {   
}

@Service:

用于标注业务层组件。

1
2
@Service
public class SystemUserService {}

@RestController:

用于标注控制层组件(如struts中的action)，包含@Controller和@ResponseBody。

1
2
@RestController
public class APIUserController {}

@ResponseBody：

表示该方法的返回结果直接写入HTTP response body中
一般在异步获取数据时使用，在使用@RequestMapping后，返回值通常解析为跳转路径，加上@responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中。比如异步获取json数据，加上@responsebody后，会直接返回json数据。

1
2
3
4
5
6
@RequestMapping(value ="/api", method = RequestMethod.GET)
@ResponseBody
public String list(SystemUser systemUser) {
    SystemUser systemUsers = systemUserService.insert(systemUser);
    return JSON.toJSONString("1111");
}

@Component：

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

1
2
3
4
@Component
public @interface Service {
    String value() default "";
}

@ComponentScan：

不要配置到具体的包上边 那样只是扫描你配置的那个包 其他的包都不会扫描

组件扫描。个人理解相当于，如果扫描到有@Component @Controller @Service等这些注解的类，则把这些类注册为bean。

1
2
3
4
5
6
7
@ComponentScan(value="com.kingdom")
@SpringBootApplication
public class SpecialtymallApplication {
	public static void main(String[] args) {
		SpringApplication.run(SpecialtymallApplication.class, args);
	}
}

@Configuration：

指出该类是 Bean 配置的信息源，相当于XML中的，一般加在主类上。

1
2
3
4
5
6
7
8
@Configuration
@EnableAutoConfiguration
@ComponentScan
public class SpecialtymallApplication {
	public static void main(String[] args) {
		SpringApplication.run(SpecialtymallApplication.class, args);
	}
}

@Bean:

相当于XML中的,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。

@EnableAutoConfiguration：

让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置，一般加在主类上。

1
2
3
4
5
6
7
8
@Configuration
@EnableAutoConfiguration
@ComponentScan
public class SpecialtymallApplication {
	public static void main(String[] args) {
		SpringApplication.run(SpecialtymallApplication.class, args);
	}
}

@AutoWired:

byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。
当加上（required=false）时，就算找不到bean也不报错。

1
2
3
4
5
6
7
@RestController
public class APIUserController {
    @Autowired
    private SystemUserService systemUserService;
}

@Qualifier：

当有多个同一类型的Bean时，可以用@Qualifier(“name”)来指定。与@Autowired配合使用

@Resource(name=”name”,type=”type”)：

没有括号内内容的话，默认byName。与@Autowired干类似的事。

@RequestMapping：

RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。
该注解有六个属性：
params:指定request中必须包含某些参数值是，才让该方法处理。
headers:指定request中必须包含某些指定的header值，才能让该方法处理请求。
value:指定请求的实际地址，指定的地址可以是URI Template 模式
method:指定请求的method类型， GET、POST、PUT、DELETE等
consumes:指定处理请求的提交内容类型（Content-Type），如application/json,text/html;
produces:指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回

1
2
3
4
5
6
7
8
9
10
11
12
13
@RestController
public class APIUserController {
    @Autowired
    private SystemUserService systemUserService;
    @RequestMapping(value ="/api/admin/systemUser/create", method = RequestMethod.POST)
    public String list(SystemUser systemUser) {
//        SystemUser systemUsers = systemUserService.insert(systemUser);
        return JSON.toJSONString(systemUser);
    }
}

@RequestParam：

用在方法的参数前面。
@RequestParam String a =request.getParameter(“a”)。

@PathVariable:

路径变量。参数与大括号里的名字一样要相同。

1
2
3
4
RequestMapping("user/get/mac/{macAddress}")
public String getByMacAddress(@PathVariable String macAddress){
　　//do something;
}

@Profiles

Spring Profiles提供了一种隔离应用程序配置的方式，并让这些配置只能在特定的环境下生效。
任何@Component或@Configuration都能被@Profile标记，从而限制加载它的时机。

1
2
3
4
5
@Configuration
@Profile("prod")
public class ProductionConfiguration {
    // ...
}

@ConfigurationProperties

Spring Boot将尝试校验外部的配置，默认使用JSR-303（如果在classpath路径中）。
你可以轻松的为你的@ConfigurationProperties类添加JSR-303 javax.validation约束注解：

1
2
3
4
5
6
7
@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
@NotNull
private InetAddress remoteAddress;
// ... getters and setters
}

@ControllerAdvice：

包含@Component。可以被扫描到。
统一处理异常。

@ExceptionHandler（Exception.class）：

用在方法上面表示遇到这个异常就执行以下方法。