Spring Boot注解简单介绍

前言

SpringBoot基于Spring4.0设计，不仅继承了Spring框架原有的优秀特性，而且还通过简化配置来进一步简化了Spring应用的整个搭建和开发过程。另外SpringBoot通过集成大量的框架使得依赖包的版本冲突，以及引用的不稳定性等问题得到了很好的解决。它简化了Spring应用程序的配置和部署过程，并提供了一套开箱即用的功能和约定，使开发人员能够快速搭建、配置和运行Spring应用程序，其中SpringBoot注解主要体现在以下方面:(1)简化配置：Spring Boot的注解可以帮助开发人员简化应用程序的配置，减少繁琐的XML配置文件，提高开发效率;(2).自动装配：Spring Boot的注解可以自动完成应用程序所需的依赖注入和Bean的创建，减少了手动配置的工作，提供了更便捷的开发方式;(3).内置服务器：Spring Boot内置了多种常用的服务器，如Tomcat、Jetty等，只需添加相关的注解即可快速启动应用程序，简化了部署和运行的过程;(4).简化RESTful开发：Spring Boot的注解可以帮助开发人员快速构建RESTful风格的接口，简化了URL映射和请求处理的过程;(5).数据库操作简化：Spring Boot集成了多种常用的数据库操作框架，如Spring Data JPA、MyBatis等，通过注解可以简化数据库操作的代码编写，提高开发效率;(6)健康监测和度量：Spring Boot提供了一系列的注解用于监测应用程序的健康状态和性能指标，方便开发人员进行应用程序的监控和调优;以下是一些常用的Spring Boot注解的介绍

目录

前言

1.@SpringBootApplication

2.@Controller

3.@RestController

4.@RequestMapping：

05.@PathVariable：

6.@RequestParam：

7.@RequestBody：

8.@ResponseBody：

9.@Autowired：

10.@Service：

11.@Repository:                                        

12.@Configuration：

14@.Valid:

15.@ConfigurationProperties:

小结

---

1.@SpringBootApplication

用于标识一个主启动类，表示这是一个Spring Boot应用程序的入口。它是一个组合注解，包含了@Configuration、@EnableAutoConfiguration和@ComponentScan等注解的功能。

@SpringBootApplication
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}

2.@Controller

用于标识一个类是控制器，处理HTTP请求并返回响应

@Controller
public class UserController {
    
    @Autowired
    private UserService userService;
    
    @RequestMapping("/users")
    public String getUsers(Model model) {
        List<User> users = userService.getUsers();
        model.addAttribute("users", users);
        return "users";
    }
    
    // 其他请求处理方法...
    
}

3.@RestController

与@Controller注解类似，但是它还包含了@ResponseBody注解，表示返回的数据将直接写入HTTP响应体中。

@RestController
@RequestMapping("/api")
public class UserController {
    @GetMapping("/users")
    public List<User> getUsers() {
        // ...
    }
}

4.@RequestMapping：

用于映射HTTP请求到处理器方法上。可以用在类和方法上，用于指定请求的URL路径和请求方法。

@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        // ...
    }
}

05.@PathVariable：

用于获取URL路径中的参数值，可以用在方法参数上。

@GetMapping("/users/{id}")
public User getUser(@PathVariable Long id) {
    // ...
}

6.@RequestParam：

用于获取HTTP请求参数的值，可以用在方法参数上。

​
@GetMapping("/users/{id}")
public User getUser(@PathVariable Long id) {
    // ...
}

​

7.@RequestBody：

用于将HTTP请求体中的JSON数据绑定到方法参数上。

@RestController
@RequestMapping("/api")
public class UserController {

    @PostMapping("/users")
    public ResponseEntity<User> createUser(@RequestBody User user) {
        // 处理请求体中的用户对象
        // 这里可以进行一些业务逻辑操作
        // 返回响应实体
        return ResponseEntity.ok(user);
    }
}

8.@ResponseBody：

用于将方法返回的数据直接写入HTTP响应体中。

@GetMapping("/users")
@ResponseBody
public List<User> getUsers() {
    // ...
}

9.@Autowired：

用于自动装配Spring容器中的Bean，可以用在构造方法、方法、字段和参数上。 

@Service
public class UserService {
    private final UserRepository userRepository;

    @Autowired
    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }
}

10.@Service：

用于标识一个类是服务层组件，通常用于定义业务逻辑。

import org.springframework.stereotype.Service;

@Service
public class UserService {

    public void createUser(User user) {
        // 业务逻辑代码，例如保存用户到数据库
    }

    public User getUserById(int id) {
        // 业务逻辑代码，例如从数据库查询用户信息
        return user;
    }

    public void updateUser(User user) {
        // 业务逻辑代码，例如更新用户信息到数据库
    }

    public void deleteUser(int id) {
        // 业务逻辑代码，例如从数据库删除用户
    }
}

11.@Repository:                                        

用于标识一个类是数据访问层组件，通常用于访问数据库或其他持久化存储。

@Repository
public class UserRepository {
    // 数据访问层的具体实现代码
}

12.@Configuration：

用于标识一个类是配置类，通常用于定义一些Bean的配置。

import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {
    // Bean definitions and other configurations
}

14@.Valid:

用于开启参数校验，可以在方法参数上加上注解来对参数进行校验。

@PostMapping("/users")
public User createUser(@Valid @RequestBody User user) {
    // ...
}
C

15.@ConfigurationProperties:

用于绑定配置文件中的属性值到Java对象中。                    

@ConfigurationProperties(prefix = "app")
public class AppProperties {
    private String name;
    private int version;
    
    // ...
}

小结

Spring Boot注解可以用于控制器的定义、请求映射、参数获取、请求体处理、依赖注入和组件管理等方面。还可以简化开发过程，提供方便的功能。熟悉和灵活运用这些注解可以提高开发效率，减少冗余代码，同时提升应用程序的可维护性和扩展性。总之，Spring Boot的注解可以帮助开发人员快速构建和管理应用程序，简化了配置和开发的过程，提高了开发效率和代码质量。