Spring boot中常用的注解，及其在项目开发中实际使用位置和示例
二.注解用法示例
1.@Controller 1.1 用在类名
@Controller
@RequestMapping("/api/v1/user")
public class UserController {}
2.@RequestMapping
2.1 用在类名
@Controller
@RequestMapping("/api/v1/user")
public class UserController {}
2.1 用在方法名
@RequestMapping(value = "getuser", method = RequestMethod.POST)
public List<User> selectAll() {
return userService.selectAll();
}
2.3 注解属性：
①. value， method；
value：指定请求的实际地址，指定的地址可以是URI Template 模式；
method：指定请求的method类型， GET、POST、PUT、DELETE等；
②.consumes，produces
consumes：指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;
produces: 指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；
③. params，headers
params： 指定request中必须包含某些参数值是，才让该方法处理。
headers： 指定request中必须包含某些指定的header值，才能让该方法处理请求。
3.@ResponseBody
3.1 用在方法名上
将返回对象输出到客户端，如果是字符串，直接输出；如果不是，则默认用Jackson序列化成Json字符串输出。
@ResponseBody
public User addUser(@RequestBody User user) {}
该注解将返回类型转换为指定格式，格式由程序控制，格式包括json、text、xml和其他。若转为Json，需要依赖Json解析Jar包。
4. @RestController
用于返回json、text、xml和其他等格式的数据，但不能返回Jsp和HTML页面。
@RestController
@RequestMapping("/api/v1/user")
public class UserController {}
5.@RequestBody
使用HandlerAdapter，配置的HttpMessageConverters来将请求内容，转为指定的对象。Spring boot 默认用Jackson来处理反序列化工作。
下面示例是将请求Json参数，利用@RequestBody直接注入到EnterpriseEntity中，
@RequestMapping(value = "/enterprise/update", method = RequestMethod.PUT)
public void updateEnterpriseInfo(@RequestBody EnterpriseEntity enterprise) {
}
6.@Service
用在ServiceImpl实现类上,声明一个业务逻辑处理类。
@Service("userService")
public class UserServiceImpl implements UserService {}
7.@Repository
用在daoImpl实现类上，声明一个数据库访问类
@Repository
public class IocDao implements IIocDao{
public void add(){
}
}
8.@Component
如用在Mybatis的Mapper类上
@Component
@Mapper
public interface UserMapper {
int deleteByPrimaryKey(Long userId);
}
9.@Configuration
@Configuration
@EnableCaching
public class RedisConfig {
@Bean
public CacheManager cacheManager(RedisTemplate redisTemplate) {
RedisCacheManager cacheManager = new RedisCacheManager(redisTemplate);
return cacheManager;
}
}
10.@Bean
@Bean(name = “kafkaContainer”)
public KafkaListenerContainerFactory<ConcurrentMessageListenerContainer<String, String>> kafkaListenerContainerFactory() {
ConcurrentKafkaListenerContainerFactory<String, String> factory = new ConcurrentKafkaListenerContainerFactory<>();
factory.setConsumerFactory(consumerFactory());
factory.setConcurrency(1);
factory.getContainerProperties().setPollTimeout(5000);
return factory;
}
11.@Qualifier
有一个接口如下：
public interface EmployeeService {
public EmployeeDto getEmployeeById(Long id);
}
有两个实现类同时实现了这个接口：
@Service("service")
public class EmployeeServiceImpl implements EmployeeService {
public EmployeeDto getEmployeeById(Long id) {
return new EmployeeDto();
}
}
@Service("service1")
public class EmployeeServiceImpl1 implements EmployeeService {
public EmployeeDto getEmployeeById(Long id) {
return new EmployeeDto();
}
}
在Controller调用时：
@Controller
@RequestMapping("/emplayee")
public class EmployeeInfoControl {
@Autowired
EmployeeService employeeService;
@GetMapping(value = {"/selectEvalCourse/{emplayeeId}"})
@ResponseBody
public Result showEmplayeeInfo(@PathVariable("emplayeeId") String emplayeeId) {
}
}
在启动项目的时候就会报错，因为有两个实现类实现接口，spring不知道应该绑定那个实现类，所以抛出错误。
@Qualifier就是为了解决这个问题，其参数名称必须为我们之前定义的@Service注解的名称之一，如下：
@Controller
@RequestMapping("/emplayee")
public class EmployeeInfoControl {
@Autowired
@Qualifier("service")
EmployeeService employeeService;
@GetMapping(value = {"/selectEvalCourse/{emplayeeId}"})
@ResponseBody
public Result showEmplayeeInfo(@PathVariable("emplayeeId") String emplayeeId) {
}
}
12.@Autowired
@Autowired
@Qualifier(value = “entityManagerFactoryPrimary”)
LocalContainerEntityManagerFactoryBean entityManager;
13.@Resource
配置类：
@Component("jpushConfig")
public class JpushConfig {
@Value("${jpush.appKey}")
private String appkey;
@Value("${jpush.masterSecret}")
private String masterSecret;
@Value("${jpush.liveTime}")
private String liveTime;
public String getAppkey() {
return appkey;
}
public String getMasterSecret() {
return masterSecret;
}
public void setLiveTime(String liveTime) {
this.liveTime = liveTime;
}
}
使用配置：
@Resource
JpushConfig jpushConfig;
14.@Value
properities属性文件中创建键值对
spring.kafka.consumer.topic=test-topic
在Java中将properities属性文件中的值，注入到属性中。
@Value("${spring.kafka.consumer.topic}")
private String topic;
15.@PathVariable
@RequestMapping("/api/{type}")
public String getUser(@PathVariable int type) {}
{type}中的type需要跟参数名统一,若不统一，可用(value = “type”)指定：
@RequestMapping("/api/{type}")
public String getUser(@PathVariable(value = "type") int myType) {}
