### VS Code 中开发 Spring 项目时正确使用 `@Mapper` 注解的指南 #### 添加必要的依赖项 为了在 Spring 项目中正确使用 `@Mapper` 注解，首先需要确保项目的 `pom.xml` 文件中包含了 MapStruct 和 MyBatis 的相关依赖。以下是常用的依赖配置： ```xml <dependency> <groupId>org.mapstruct</groupId> <artifactId>mapstruct</artifactId> <version>1.5.3.Final</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <!-- 如果使用 MyBatis --> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.3.0</version> </dependency> ``` 以上依赖分别用于对象映射工具 MapStruct 和 MyBatis 数据库框架的支持[^1]。 #### 配置 Maven 插件 为了让 MapStruct 正确生成实现类，在 `pom.xml` 中还需要添加以下插件配置： ```xml <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.8.1</version> <configuration> <source>17</source> <target>17</target> <annotationProcessorPaths> <path> <groupId>org.mapstruct</groupId> <artifactId>mapstruct-processor</artifactId> <version>1.5.3.Final</version> </path> </annotationProcessorPaths> </configuration> </plugin> </plugins> </build> ``` 此部分配置确保了编译期间能够正确处理注解处理器[^3]。 #### 使用 `@Mapper` 注解 当使用 MapStruct 进行对象映射时，可以通过如下方式定义接口： ```java import org.mapstruct.Mapper; import org.mapstruct.Mapping; @Mapper(componentModel = "spring") public interface UserMapping { @Mapping(source = "studentName", target = "userName") User mapStudentToUser(Student student); } ``` 在此示例中，`componentModel = "spring"` 表明该接口会被注册为 Spring 容器中的 Bean，从而可以直接通过依赖注入的方式使用[^4]。 如果使用的是 MyBatis，则需注意 `@Mapper` 是 MyBatis 提供的注解，主要用于声明 DAO 接口。此时应确保在 Spring 配置文件中启用了 Mapper 扫描功能，或者手动注册 Mapper 实现类[^2]。 #### 解决常见问题 1. **无法找到生成的实现类** - 确保已安装并启用 Maven Annotation Processor 支持。 - 清理并重新构建项目：运行命令 `mvn clean install` 后再尝试刷新 IDE 缓存。 2. **IDEA/VSCode 不识别生成的代码** - 对于 VS Code 用户，建议安装官方推荐的 Java Extension Pack 并开启 annotation processor 设置： ```json { "java.annotationProcessors.enabled": true, "maven.updateSnapshots": "always" } ``` 3. **MyBatis 映射失败** - 检查 XML 文件路径是否正确以及 SQL 是否语法无误。 - 确认 Mapper 接口已被正确扫描到 Spring 上下文中。 ---