Java常用注解扩展对比举例详解

2025-03-26 02:50

本文主要是介绍Java常用注解扩展对比举例详解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《Java常用注解扩展对比举例详解》:本文主要介绍Java常用注解扩展对比的相关资料,提供了丰富的代码示例,并总结了最佳实践建议,帮助开发者更好地理解和应用这些注解,需要的朋友可以参考下...

一、@Controller 与 @RestController 对比

对比维度@Controller@RestController
定义Spring MVC 的基础控制器注解@Controller + @ResponseBody 的组合注解
返回值处理返回视图名称(需配合视图解析器)直接返回jsON/XML数据(自动添加 @ResponseBody
适用场景传统MVC架构(如JSP/Thymeleaf页面渲染)RESTful API开发(前后端分离场景)
HTTP响应头Content-Type: text/html(默认)Content-Type: application/json(默认)
代码示例```Java```java
@Controller@RestController
public class WebCtrl {public class ApiCtrl {
@GetMapping(“/page”)@GetMapping(“/data”)
public String page() {public User data() {
return “index”; // 返回视图名return userService.findUser(); // 自动转JSON
}}
}}

二、使用 @Data 与 不使用 @Data 对比

对比维度使用 @Data不使用 @Data
代码量自动生成以下方法:
- 所有字段的getter/setter
toString()equals()/hashCode()
需手动编写所有方法
维护性字段增减时无需修改方法字段变更需同步修改相关方法
继承关系处理需显式添加 @EqualsAndHashCode(callSuper=true) 包含父类字段手动编写时可直接控制是否包含父类字段
框架兼容性依赖Lombok插件(需IDE支持)无额外依赖
代码示例```java```java
@Datapublic class User {
public class User {private Long id;
private Long id;private String name;
private String name;
// 自动生成所有方法// 手动编写getter/setter
}public Long getId() { return id; }
public void setId(Long id) { this.id = id; }
// …其他方法
}

注意事项

  • 使用 @Data 时,若类有继承关系,需添加 @EqualsAndHashCode(callSuper=true)
  • 某些场景(如JPA实体类)需显式定义无参构造器(通过 @NoArgsConstructor

三、使用 @TableName 与 不使用 @TableName 对比

对比维度使用 @TableName不使用 @TableName
表名映射规则显式指定数据库表名(如 @TableName("sys_user")按MyBATis-Plus默认规则映射:
类名驼lWTRlvsoli峰转下划线(如 SysUser → sys_user
适用场景1. 表名含特殊字符(如 user-info
2. 类名与表名无对应关系
类名与表名严格遵循驼峰转下划线规则
全局配置覆盖优先级高于全局配置可通过配置文件统一设置表名前缀:
mybatis-plus.global-config.db-config.table-prefix=sys_
代码示例```java```java
@Data@Data
@TableName(“sys_user”) // 显式指定表名public class SysUser { // 默认映射为 sys_user
public class User {private Long id;
private Long id;}
}

注意事项

  • 表名包含SQL关键字时需转义:@TableName("order")
  • 分表场景可通过动态表名处理器(TableNameHandler)实现

四、依赖注入注解对比

注解对核心区别使用场景
@Autowired vs @Resource@Autowired(Spring)按类型注入
@Resource(JSR-250)按名称注入
明确指定Bean名称时用@Resource,优先使用构造器注入时用@Autowired
@Primary vs @Qualifier@Primary标记首选Bean
@Qualifier指定具体Bean名称
存在多个相同类型Bean时,优先使用@Primary,需精确控制时用@Qualifier

代码示例

// @Autowired + @Qualifier
@Autowired 
@Qualifier("mysqlDataSource")
private DataSource dataSource;

// @Resource
@Resource(name = "oracleDataSource")
private DataSource dataSource;

五、Spring MVC 参数绑定注解对比

注解对核心区别使用场景
@RequestParam vs @PathVariable@RequestParam获取URL参数
@PathVariable获取URI模板变量
RESTful风格URL用@PathVariable,传统表单参数用@RequestParam
@ModelAttribute vs @RequestBody@ModelAttribute绑定Form表单数据
@RequestBody绑定JSON请求体
表单提交用@ModelAttribute,API接口传输复杂对象用@RequestBody

代码示例

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

// RequestBody
@PostMapping("/users")
public ResponseEntity<?> createUser(@RequestBody UserDTO userDTO) { ... }

六、JPA/Hibernate 映射注解对比

注解对核心区别使用场景
@Entity vs @Table@Entity声明JPA实体类
@Table指定数据库表名
类名与表名不一致时使用@Table
@Column vs @Transient@Column映射数据库列
@Transient标记非持久化字段
字段需要特殊列名或类型时用@Column,临时计算字段用@Transient
@OneToMany vs @ManyToOne- 定义一对多/多对一关系根据业务关系方向选择(部门-员工:部门用@OneToMany,员工用@ManyToOne

代码示例

@EntitylWTRlvsoli
@Table(name = "departments")
public class Department {
    @OneToMany(mappedBy = "department")
    private List<Employee> employees;
}

@Entity
public class Employee {
    @ManyToOne
    @JoinColumn(name = "dept_id")
    private Department department;
}

七、Spring Boot 配置注解对比

注解对核心区别使用场景
@Value vs @ConfigurationProperties@Value注入单个属性
@ConfigurationProperties批量绑定属性
简单配置用@Value,复杂配置对象用@ConfigurationProperties
@Profile vs @Conditional@Profile按环境激活配置
@Conditional按条件创建Bean
多环境配置用@Profile,动态装配逻辑用@Conditional

配置示例

# application.yml
app:
  security:
    enabled: true
    timeout: 300

代码实现

@Configuration
@ConfigurationProperties(prefix = "app.security")
public class SecurityConfig {
    private boolean enabled;
    private int timeout;
    // getters/setters
}

八、Lombok 注解对比

注解对核心区别使用场景
@Data vs @Value@Data生成可变对象
@Value生成不可变对象(final字段)
需要修改字段值时用@Data,只读数据传输对象用@Value
@Builder vs @AllArgsConstructor@Builder支持链式构建
@AllArgsConstructor生成全参构造器
复杂对象构建用@Builder,依赖注入全参构造用@AllArgsConstructor

代码示例

@Value
@Builder
public class ImmutablePoint {
    prwww.chinasem.cnivate final int x;
    private final int y;
}

// 使用
ImmutablePoint point = ImmutablePoint.builder().x(10).y(20).build();

九、事务管理注解对比

注解对核心区别使用场景
@Transactional vs @Modifying@Transactional声明事务边界
@Modifying标记DML操作
服务层方法用@Transactional,JPA更新查询用@Modifying

代码示例

@Service
public class UserService {
    @Transactional
    public void updateUser(User user) {
        userRepository.save(user);
    }
}

@Repository
public pythoninterface UserRepository extends JpaRepository<User, Long> {
    @Modifying
    @Query("UPDATE User u SET u.name = ?1 WHERE u.id = ?2")
    int updateNameById(String name, Long id);
}

十、测试相关注解对比

注解对核心区别使用场景
@Mock vs @MockBean@Mock(Mockito)创建模拟对象
@MockBean(Spring Boot Test)替换Spring容器中的Bean
单元测试用@Mock,集成测试用@MockBean
@SpringBootTest vs @WebMvcTest@SpringBootTest加载完整上下文
@WebMvcTest仅加载Web层组件
全集成测试用@SpringBootTest,控制层隔离测试用@WebMvcTest

测试示例

// 全集成测试android
@SpringBootTest
class UserServiceIntegrationTest {
    @Autowired
    private UserService userService;
}

// 控制层测试
@WebMvcTest(UserController.class)
class UserControllerTest {
    @MockBean
    private UserService userService;
    @Autowired
    private MockMvc mockMvc;
}

综合对比总结表

功能场景推荐注解组合典型应用
REST API开发@RestController + @RequestBody + @Valid前后端分离接口开发
JPA实体映射@Entity + @Table + @Column + @OneToMany数据库表结构映射
配置管理@ConfigurationProperties + @Profile多环境配置切换
测试覆盖@SpringBootTest + @MockBean + @DataJpaTest(按需选择)分层测试策略
依赖注入构造器注入优先,@Autowired + @Qualifier避免循环依赖

最佳实践建议

  • 分层使用严格遵循Controller→Service→Repository分层架构,避免跨层注解混用。

  • 注解最小化

    • 优先使用框架提供的组合注解(如@RestController代替@Controller+@ResponseBody
    • 避免重复注解(如同时使用@Component@Service
  • Lombok规范

    • 实体类统一使用@Data + @Builder
    • 禁用无约束的@AllArgsConstructor
  • 事务控制

    • Service层统一声明@Transactional(readOnly = true)
    • 写操作显式指定@Transactional(rollbackFor = Exception.class)
  • 测试隔离

    • 单元测试使用Mockito + JUnit5
    • 集成测试按需选择@WebMvcTest@DataJpaTest

通过系统化的注解对比与组合使用,可显著提高代码规范性和团队协作效率。建议结合SonarLint等代码质量管理工具,确保注解使用的合理性与一致性。

总结

到此这篇关于Java常用注解扩展对比的文章就介绍到这了,更多相关Java常用注解扩展内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程China编程(www.chinasem.cn)!

这篇关于Java常用注解扩展对比举例详解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!


原文地址:http://www.cppcns.com/ruanjian/java/705484.html
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.chinasem.cn/article/1153938

相关文章

Spring Boot配置和使用两个数据源的实现步骤

《SpringBoot配置和使用两个数据源的实现步骤》本文详解SpringBoot配置双数据源方法,包含配置文件设置、Bean创建、事务管理器配置及@Qualifier注解使用,强调主数据源标记、代... 目录Spring Boot配置和使用两个数据源技术背景实现步骤1. 配置数据源信息2. 创建数据源Be

Spring Boot 3.x 中 WebClient 示例详解析

《SpringBoot3.x中WebClient示例详解析》SpringBoot3.x中WebClient是响应式HTTP客户端,替代RestTemplate,支持异步非阻塞请求,涵盖GET... 目录Spring Boot 3.x 中 WebClient 全面详解及示例1. WebClient 简介2.

Java中使用 @Builder 注解的简单示例

《Java中使用@Builder注解的简单示例》@Builder简化构建但存在复杂性,需配合其他注解,导致可变性、抽象类型处理难题,链式编程非最佳实践,适合长期对象,避免与@Data混用,改用@G... 目录一、案例二、不足之处大多数同学使用 @Builder 无非就是为了链式编程,然而 @Builder

在IntelliJ IDEA中高效运行与调试Spring Boot项目的实战步骤

《在IntelliJIDEA中高效运行与调试SpringBoot项目的实战步骤》本章详解SpringBoot项目导入IntelliJIDEA的流程,教授运行与调试技巧,包括断点设置与变量查看,奠定... 目录引言:为良驹配上好鞍一、为何选择IntelliJ IDEA?二、实战:导入并运行你的第一个项目步骤1

Spring Boot从main方法到内嵌Tomcat的全过程(自动化流程)

《SpringBoot从main方法到内嵌Tomcat的全过程(自动化流程)》SpringBoot启动始于main方法,创建SpringApplication实例,初始化上下文,准备环境,刷新容器并... 目录1. 入口:main方法2. SpringApplication初始化2.1 构造阶段3. 运行阶

Linux之platform平台设备驱动详解

《Linux之platform平台设备驱动详解》Linux设备驱动模型中,Platform总线作为虚拟总线统一管理无物理总线依赖的嵌入式设备,通过platform_driver和platform_de... 目录platform驱动注册platform设备注册设备树Platform驱动和设备的关系总结在 l

Olingo分析和实践之EDM 辅助序列化器详解(最佳实践)

《Olingo分析和实践之EDM辅助序列化器详解(最佳实践)》EDM辅助序列化器是ApacheOlingoOData框架中无需完整EDM模型的智能序列化工具,通过运行时类型推断实现灵活数据转换,适用... 目录概念与定义什么是 EDM 辅助序列化器?核心概念设计目标核心特点1. EDM 信息可选2. 智能类

Spring Boot3.0新特性全面解析与应用实战

《SpringBoot3.0新特性全面解析与应用实战》SpringBoot3.0作为Spring生态系统的一个重要里程碑,带来了众多令人兴奋的新特性和改进,本文将深入解析SpringBoot3.0的... 目录核心变化概览Java版本要求提升迁移至Jakarta EE重要新特性详解1. Native Ima

Java中的xxl-job调度器线程池工作机制

《Java中的xxl-job调度器线程池工作机制》xxl-job通过快慢线程池分离短时与长时任务,动态降级超时任务至慢池,结合异步触发和资源隔离机制,提升高频调度的性能与稳定性,支撑高并发场景下的可靠... 目录⚙️ 一、调度器线程池的核心设计 二、线程池的工作流程 三、线程池配置参数与优化 四、总结:线程

Spring Boot 与微服务入门实战详细总结

《SpringBoot与微服务入门实战详细总结》本文讲解SpringBoot框架的核心特性如快速构建、自动配置、零XML与微服务架构的定义、演进及优缺点,涵盖开发环境准备和HelloWorld实战... 目录一、Spring Boot 核心概述二、微服务架构详解1. 微服务的定义与演进2. 微服务的优缺点三