一 问题背景
参考:《Spring Cloud 微服务架构开发》——黑马程序员。
1 新建一个公共工程 common-client
使用 Spring Initializer 方式新建一个名称为 common-client 的 Spring Boot 工程,这里将 Group 命名为 com.itheima,将 Artifact 命名为 common-client。如图1-1所示。
图1-1 新建工程 common-client
2 新建 Module 项目 dm-common-module
由于本工程的目的是实现资源共享,因此,我们创建好工程后,删除工程 common-client 中的 src 文件夹,并新建一个 Module 项目 dm-common-module,在 dm-common-module 中创建 User 实体类和 FeignService 接口及其所在包,并在 pom.xml 文件中指定项目的打包方式为 jar 包形式。如下图所示。
图1-2 新建项目 dm-common-module
项目建好后需要更改 SDK,位置:File > Project Structure > Project Settings > Project > SDK。
(1)整理好后的 pom.xml 文件如例1-1所示。
例1-1 pom.xml(dm-common-module)
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.7.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.itheima</groupId>
<artifactId>dm-common-module</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>dm-common-module</name>
<description>dm-common-module</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.SR2</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
(2)在 dm-common-module 中创建 entity 包,并在该包中创建实体类 User ,具体代码如例1-2所示。
例1-2 dm-common-module\src\main\java\com\itheima\dmcommonmodule\entity\User.java
package com.itheima.dmcommonmodule.entity;
public class User {
private String name;
private Integer age;
public User(String name, Integer age) {
this.name = name;
this.age = age;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
@Override
public String toString() {
return "name=" + name + ", age=" + age;
}
}
(3)在 dm-common-module 中创建 service 包,并在该包下创建接口 FeignService,通过添加注解指定要调用的服务,具体代码如例1-3所示。
例1-3 dm-common-module\src\main\java\com\itheima\dmcommonmodule\service\FeignService.java
package com.itheima.dmcommonmodule.service;
import com.itheima.dmcommonmodule.entity.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Service;
import org.springframework.web.bind.annotation.*;
@Service
@FeignClient(name = "eureka-provider")
public interface FeignService {
@RequestMapping(value = "/hello1", method = RequestMethod.GET)
public String hello(@RequestParam("name") String name);
@RequestMapping(value = "/hello2", method = RequestMethod.GET)
public User hello(@RequestParam("name") String name, @RequestHeader("age") int age);
@RequestMapping(value = "/hello3", method = RequestMethod.POST)
public String hello(@RequestBody User user);
@RequestMapping(value = "/hello", method = RequestMethod.GET)
public String sayHello();
}
3 将 Module 项目打成 jar 包到 Maven 仓库
选择 IDEA 工具右侧的“Maven > dm-common-module > Lifecyle”,双击“Lifecyle”中的“install”进行打包。打包完成后,会在工程 dm-common-module 的 target 目录下生成刚刚打包的 jar 包。
或者进入终端 Terminal cd 到项目位置用命令 mvn install 打包,如:dm-common-module> mvn install。
结果显示打包含测试错误,直接将测试语句注释掉即可(或者使用 mvn install -DskipTests
命令跳过测试)。如例1-4所示。
例1-4 dm-common-module\src\test\java\com\itheima\dmcommonmodule\DmCommonModuleApplicationTests.java
package com.itheima.dmcommonmodule;
import org.junit.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class DmCommonModuleApplicationTests {
// @Test
// void contextLoads() {
// }
}
重新打包,依次双击“clean”、“install”,或 mvn clean install。
4 改造 eureka-provider
(1)在 pom.xml 中,引入 dm-common-module 工程依赖,代码如例1-5所示。
例1-5 pom.xml(eureka-provider)
<dependency>
<groupId>com.itheima</groupId>
<artifactId>dm-common-module</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.7.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.itheima</groupId>
<artifactId>eureka-provider</artifactId>
<version>1.0-SNAPSHOT</version>
<name>eureka-provider</name>
<description>eureka-provider</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.SR2</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>com.itheima</groupId>
<artifactId>dm-common-module</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
(2)创建 controller 包,在该包下创建 RefactorHelloController 类,该类用于实现 dm-common-module 的 FeignService 接口。FeignService 类是一个公共接口,其他类通过继承该接口达到对该类中资源的共享。RefactorHelloController 类的具体代码如例1-6所示。
例1-6 eureka-provider\src\main\java\com\itheima\eurekaprovider\controller\RefactorHelloController.java
package com.itheima.eurekaprovider.controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import com.itheima.dmcommonmodule.entity.User;
import com.itheima.dmcommonmodule.service.FeignService;
@RestController
public class RefactorHelloController implements FeignService{
@Override
public String hello(@RequestParam("name") String name) {
return "Hello " + name;
}
@Override
public User hello(@RequestHeader("name") String name, @RequestHeader("age") int age) {
return new User(name, age);
}
@Override
public String hello(@RequestBody User user) {
return "Hello " + user.getName() + ", " + user.getAge();
}
@Override
public String sayHello() {
return null;
}
}
至此,问题背景搭建完成。
二 问题描述
检查 Maven 仓库,发现生成的 dm-common-module 包是完整的,在 eureka-provider 下的 External Libraries 中也能找到 dm-common-module 包,且导入依赖项设置无误,项目清除缓存后重启,清除并重建 jar 包等方法都尝试过后在 RefactorHelloController 类中还是无法导入 User 类和 FeignService 接口,报错“Cannot resolve symbol 'dmcommonmodule'”。
三 问题分析
1 初步分析
出现这种情况的可能原因有:
-
依赖冲突:检查项目中是否有其他依赖与
dm-common-module
依赖冲突。可以在pom.xml
或build.gradle
文件中查看是否有多个版本的同一依赖存在。 -
类路径问题:确保
dm-common-module
依赖已经正确下载并包含在项目的类路径中。可以在 IDEA 中查看项目结构,确保dm-common-module
依赖包在 External Libraries 中可见。 -
IDEA 缓存问题:有时,IDEA 的缓存可能会导致依赖无法正确解析。可以尝试清理 IDEA 缓存。在 IntelliJ IDEA 中,可以通过
File > Invalidate Caches > Invalidate and Restart
来清理缓存并重启 IDEA。 -
依赖范围:检查
dm-common-module
依赖的范围是否正确。如果在pom.xml
中使用了scope
标签,确保它的值是compile
或runtime
,而不是test
或provided
。 -
模块配置:如果项目是多模块项目,确保
dm-common
依赖在所有需要的模块中都已正确添加。
尝试未果,问了问前辈和 ChatGPT。
2 原因总结
可能与 Maven 打包和依赖处理有关。使用 spring-boot-maven-plugin
时,默认情况下会将项目打包为可执行 JAR,这可能会影响其他项目对其中类的访问。去掉该配置或添加 <classifier>exec</classifier>
可以改变打包行为,从而生成一个标准的 JAR 文件,确保可以正确导入类。
将项目打包为可执行 JAR 时,spring-boot-maven-plugin
会将所有的类和资源打包到一个 JAR 文件中,并且通常会将主类的入口点标记出来。这种打包方式的目标是为了创建一个可独立运行的应用程序。
如果 JAR 包被标记为可执行的,它可能会影响其他项目的依赖解析,尤其是在类路径管理和模块加载方面。具体来说:
-
类路径结构:可执行 JAR 文件通常会包含一个特定的 META-INF/MANIFEST.MF 文件,其中定义了主类和其他运行时信息。这可能会导致某些工具或框架在加载类时出现问题。
-
依赖冲突:可执行 JAR 中可能包含项目所有依赖的副本,如果其他项目也引用了这些依赖,可能会导致版本冲突或类加载问题。
-
打包方式:标准 JAR 文件只关注类和资源,而可执行 JAR 文件还包含运行时所需的信息,这可能在某些情况下导致其他项目无法正常解析和使用这些类。
通过将可执行 JAR 改为标准 JAR,就可以确保项目中的类可以被其他项目正常访问和使用。去掉 spring-boot-maven-plugin
的配置等效于生成一个标准的 JAR 文件。默认情况下,如果没有指定任何特殊配置,Maven 会打包项目为一个标准的 JAR 文件。
<classifier>exec</classifier>
的作用:
-
定义附加分类:使用
<classifier>
可以为 JAR 文件添加一个附加的分类,通常用于区分不同类型的构件。例如,使用exec
分类可以标识这是一个可执行的版本,或者用于特定的构建。 -
创建不同的构件:当添加了分类时,Maven 会生成一个带有分类名称的 JAR 文件(例如,
your-artifact-1.0-SNAPSHOT-exec.jar
)。这使得你可以同时拥有多个版本的同一个构件,适用于不同的场景(如可执行版本、测试版本等)。 -
避免冲突:通过分类,可以避免不同类型的 JAR 文件在依赖管理时产生冲突,确保在引用时明确区分。
在本案例中,添加 <classifier>exec</classifier>
后,Maven 生成的 JAR 文件具有了特定的分类,这可能使得其他项目能够正确解析和使用其中的类。
四 解决办法
1 方法一
在 dm-common-module 的 pom.xml 文件中删除以下代码,使生成的 jar 包为标准 JAR。删除后清除原 jar 包再重建。删除部分如例4-1所示。
例4-1 spring-boot-maven-plugin
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
2 方法二
在 dm-common-module 的 pom.xml 文件中修改以下代码,为生成的 jar 包指定特定分类,使得其他项目能够正确解析和使用其中的类。修改部分如例4-2所示。
例4-2 spring-boot-maven-plugin
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<classifier>exec</classifier>
</configuration>
</plugin>
</plugins>
</build>
五 总结
以上就是此次分享的一个学习经验:当项目无法导入本地 jar 包时可能遇到的一种情况。
感谢观看,如有感想,欢迎留言分享。