Spring Boot 多模块开发， 子模块的bean调用问题及解决方法

最新推荐文章于 2024-04-26 20:19:53 发布
最新推荐文章于 2024-04-26 20:19:53 发布
阅读量6.6k 收藏 15
点赞数 2
分类专栏： Spring Boot 文章标签： spring java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/it_xiaolei/article/details/120927645
版权

Spring Boot 多模块工程

1、新建一个maven工程

新建maven工程

工程名 ：spring-boot-sample-project

spring-boot-sample-project

删除多余的文件，只留spring-boot-sample-project工程中的pom.xml文件

父工程pom.xml文件

2、在spring-boot-sample-project工程中增加子模块

在这里插入图片描述

新增：spring-boot-sample-api 模块，注意图中2位置的包名com.example.sample.api,因为后面会涉及到多模块之间的相互调用，为了方便扫描，将包名统一成com.example.sample.模块的名

在这里插入图片描述

同理，新增：spring-boot-sample-web模块，选择Spring Boot web开发所需要的依赖的，这里我勾选了Spring Web 和 Lombok

在这里插入图片描述

最后整个工程目录如下：

在这里插入图片描述

3、配置pom.xml 文件

3.1、父类工程spring-boot-sample-project的pom.xml

1、首先是父类工程的基本信息

<!-- 基本信息 -->
    <description>Spring Boot 多模块构建</description>
    <modelVersion>4.0.0</modelVersion>
    <name>spring-boot-sample</name>
    <packaging>pom</packaging>

    <!-- 项目说明：这里作为聚合工程的父工程 -->
    <groupId>com.example</groupId>
    <artifactId>spring-boot-sample-project</artifactId>
    <version>1.0-SNAPSHOT</version>

2、因为整个工程都会依赖于Spring Boot，因此spring-boot-sample-project需要继承Spring Boot父类

<!-- 继承说明：这里继承SpringBoot提供的父工程 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.6</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

3、声明子模块，创建好的子模块放到modules

<!-- 模块说明：这里声明多个子模块 -->
    <modules>
        <module>spring-boot-sample-api</module>
        <module>spring-boot-sample-web</module>
    </modules>

4 、版本管理，可以将子模块等需要版本管理的依赖放到dependencyManagement进行版本管理

 <!-- 版本说明：这里统一管理依赖的版本号 -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.example</groupId>
                <artifactId>spring-boot-sample-api</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
            <dependency>
                <groupId>com.example</groupId>
                <artifactId>spring-boot-sample-web</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

5、其他

3.1.1、完整的父工程pom.xml配置代码
<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <!-- 基本信息 -->
    <description>Spring Boot 多模块构建</description>
    <modelVersion>4.0.0</modelVersion>
    <name>spring-boot-sample-project</name>
    <packaging>pom</packaging>

    <!-- 项目说明：这里作为聚合工程的父工程 -->
    <groupId>com.example</groupId>
    <artifactId>spring-boot-sample-project</artifactId>
    <version>1.0-SNAPSHOT</version>

    <!-- 继承说明：这里继承SpringBoot提供的父工程 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.6</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <!-- 模块说明：这里声明多个子模块 -->
    <modules>
        <module>spring-boot-sample-api</module>
        <module>spring-boot-sample-web</module>
    </modules>
    <!--jdk 版本 -->
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <!-- 版本说明：这里统一管理依赖的版本号 -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.example</groupId>
                <artifactId>spring-boot-sample-api</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
            <dependency>
                <groupId>com.example</groupId>
                <artifactId>spring-boot-sample-web</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
        </dependencies>
    </dependencyManagement>


</project>
3.2、配置子模块pom.xml

子模块配置都大同小异，故以配置spring-boot-sample-webweb为例

1、注释掉子模块默认的Spring Boot 父工程，

将子模块的父工程配置为继承至spring-boot-sample-project

 <!--<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.6</version>
        <relativePath/> &lt;!&ndash; lookup parent from repository &ndash;&gt;
    </parent>-->
    <!--修改继承的父工程-->
    <parent>
        <groupId>com.example</groupId>
        <artifactId>spring-boot-sample-project</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

2、子模块自己的依赖，因为web模块会依赖api模块因此增加spring-boot-sample-api依赖

<dependencies>
    <!--依赖 spring-boot-sample-api -->
    <dependency>
        <groupId>com.example</groupId>
        <artifactId>spring-boot-sample-api</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>
3.2.1 子模块完整的pom.xml配置
<?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.5.6</version>
        <relativePath/> &lt;!&ndash; lookup parent from repository &ndash;&gt;
    </parent>-->
    <!--修改继承的父类-->
    <parent>
        <groupId>com.example</groupId>
        <artifactId>spring-boot-sample-project</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.example</groupId>
    <artifactId>spring-boot-sample-web</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-boot-sample-web</name>
    <description>Demo project for Spring Boot</description>

    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>spring-boot-sample-api</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>
3.3 、其他

当然，web模块的依赖也可以直接放到父工程的pom.xml里面，这样只要继承了父工程的pom就可以使用了，比如将：spring-boot-starter-web放到父工程pom依赖中，则子模块只要继承了父工程，就不用再次依赖了。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

4、启动

4.1、启动 spring-boot-sample-project工程

一般情况下，整个工程都只会留一个启动类，所以我们将api中的启动类删除，只留子模块 spring-boot-sample-web的启动类，找到启动类我们直接运行他

在这里插入图片描述

启动成功之后直接访问： http://localhost:8080/ ，出现下面页面表明我们成功了。

在这里插入图片描述

4.2、解决多模块调用问题
4.2.1 、子模块spring-boot-starter-web测试代码。

我们在web模块添加简单的测试代码，编写代码如下

package com.example.sample.web.controller;

import com.example.sample.web.service.IHelloService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**
 * HelloController class
 *
 * @author zhangl
 * @date 2021/10/23 13:42
 */
@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello(){
        return "Hello World ! ";
    }
}

运行结果：

在这里插入图片描述

增加一个service接口的调用，HelloController代码如下：

package com.example.sample.web.controller;

import com.example.sample.web.service.IHelloService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**
 * HelloController class
 *
 * @author zhangl
 * @date 2021/10/23 13:42
 */
@RestController
public class HelloController {
    @Resource
    private IHelloService helloService;
    @GetMapping("/hello")
    public String hello(){
        return "Hello World ! " + helloService.sayHello();
    }
}

接口 IHelloService 代码如下：

package com.example.sample.web.service;

import org.springframework.stereotype.Service;

/**
 * iHelloService interface
 *
 * @author zhangl
 * @date 2021/10/23 13:43
 */
@Service
public interface IHelloService {
    /**
     * 测试方法
     * @return
     */
    String sayHello();
}

实现类 HelloServiceImpl 代码如下

package com.example.sample.web.service.impl;

import com.example.sample.web.service.IHelloService;
import org.springframework.stereotype.Service;

/**
 * HelloServiceImpl class
 *
 * @author zhangl
 * @date 2021/10/23 13:44
 */
@Service(value = "iHelloService")
public class HelloServiceImpl implements IHelloService {
    @Override
    public String sayHello() {
        return "Hello IHelloServiceImpl ... ";
    }
}

代码结构如下：

在这里插入图片描述

运行结果，将调用的方法sayHello里面的字符串拼接到 Hello World 后面

在这里插入图片描述

4.2.2、Web模块使用spring-boot-sample-api模块的代码

在spring-boot-sample-api模块创建一个类 ITestApiService，里面有一个**success()**方法，返回一个字符串

package com.example.sample.api.service;

import org.springframework.stereotype.Service;

/**
 * TestApiService interface
 *
 * @author zhangl
 * @date 2021/10/23 14:03
 */
@Service
public interface ITestApiService {
    /**
     * 返回一个字符串
     * @return
     */
    String success();
}

实现类 TestApiServiceImpl，返回字符串**“看见这个字符串，说明你多模块调用成功了！”**

package com.example.sample.api.service.impl;

import com.example.sample.api.service.ITestApiService;
import org.springframework.stereotype.Service;

/**
 * TestApiServiceImpl class
 *
 * @author zhangl
 * @date 2021/10/23 14:04
 */
@Service(value = "iTestApiService")
public class TestApiServiceImpl implements ITestApiService {
    @Override
    public String success() {
        return " 看见这个字符串，说明你多模块调用成功了！";
    }
}

将 ITestApiService类注入到 spring-boot-starter-web的 HelloController中，代码如下

package com.example.sample.web.controller;

import com.example.sample.api.service.ITestApiService;
import com.example.sample.web.service.IHelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**
 * HelloController class
 *
 * @author zhangl
 * @date 2021/10/23 13:42
 */
@RestController
public class HelloController {
    @Resource
    private IHelloService helloService;
    /**
     *  注入 api 模块的 ITestApiService 接口
      */
    @Resource
    private ITestApiService testApiService;
    @GetMapping("/hello")
    public String hello(){
        //拼接字符
        return "Hello World ! " + helloService.sayHello() + testApiService.success();
    }
}

项目结构如下:

在这里插入图片描述

在这里插入图片描述

运行，报错

***************************
APPLICATION FAILED TO START
***************************

Description:

A component required a bean of type 'com.example.sample.api.service.ITestApiService' that could not be found.


Action:

Consider defining a bean of type 'com.example.sample.api.service.ITestApiService' in your configuration.

在这里插入图片描述

解决方法，在启动类增加注解，指定扫描的包即可；@ComponentScan(basePackages = {“com.example.sample”}),代码如下：

package com.example.sample.web;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.stereotype.Component;

/**
 *
 * @author zhangl
 */
@ComponentScan(basePackages = {"com.example.sample"})//扫描com.example.sample下的文件
@SpringBootApplication
public class SpringBootSampleWebApplication {

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

}

当然还有别的方法解决。但在此只介绍@ComponentScan注解

再次启动，并访问http://localhost:8080/hello，结果如下：

在这里插入图片描述

5、示例代码

代码托管于 https://gitee.com/zzhangleiz/spring-boot-sample.git

上心
关注
  • 2
    点赞
  • 踩
  • 15
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
spring在@Bean注解中initMethod调用方法异步
06-05
来源于sofaboot
springboot跨模块调用
dxcll的博客
03-29 6702
springboot跨模块调用，跨模块使用@Autowired 报红
Spring boot 使用xml引入添加其他module对象
guozhaohui628
01-23 2398
最近一个项目 Spring boot 项目需要引入其他 module 中的对象，找了很久希望可以像 SSM 框架中在 xml 中定义对象 bean ，放到 spring 容器中，当需要用时直接取就是了。开始找了很多注解，以为可以通过扫描实现，最后还是不行，找到引入 xml 方式实现。 Spring boot 项目创建 xml 整个项目如下图，上面是一个 Spring boot 项目，下面是一个...
SpringBoot项目多模块开发详解
m0_73625251的博客
03-04 1389
将一个复杂项目拆分成多个模块是解决上述问题的一个重要方法，多模块的划分可以降低代码之间的耦合性（从类级别的耦合提升到jar包级别的耦合），每个模块都可以是自解释的（通过模块名或者模块文档），模块还规范了代码边界的划分，开发者很容易通过模块确定自己所负责的内容。
SpringBoot中如何在一个模块中引入另一个模块
m0_44980168的博客
05-12 2463
1.springBoot中有cms_dev项目，下面有ai模块和dms模块，而且ai模块中没有启动类，需要将ai引入到dms模块中。1、在需要调用的模块的pom文件中添加被调用模块的依赖，也就是在dms模块的pom.xml中去添加ai的依赖。
lambda-vs-beanstalk
05-12
描述 这是我使用Lambda + API Gateway或Elastic Beanstalk在AWS上部署HTTP API的实验的源代码。 您可以在相应的博客文章中找到更多上下文和信息： 模组 该项目包含两个sbt模块： lambda和elb 。 它们都包含或多或少的相同功能，但一个用于Lambda部署，另一个用于在Elastic Beanstalk上部署。 发布 sbt publish 部署 ./terraformw lambda apply ./terraformw elb apply
【springboot】微服务，实现模块之间的调用
weixin_56851586的博客
11-21 4614
springboot就是spring，是快速配置spring的脚手架，springcloud是很多框架的集合，要使用里面的框架依赖于springboot。@FeignClient(“service-vod”) 指定模块其中service-vod为模块名称，但不能有_/vodService/vod/video/deleteByVoId/{videoId} 路径不能错。地址：http://localhost:8848/nacos。将模块在注册中心中注册，实现微服务模块之间的互相调用。
在一个springboot模块里面调用另外一个模块的方法
RocZhang的博客
08-03 2129
添加其他模块的bean时，spring并不能直接扫描到该bean，需要我们手动设置扫描路径。
SpringBoot项目模块间通信的两种方式
qq_42108331的博客
07-11 1202
SpringBoot项目模块间通信的两种方式
spring boot的pom.xml第一行代码报错
guttaoqibao的博客
09-16 676
具体修改地方 <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.5.RELEASE<...
springboot调用外部接口的三个方法
D_Boat的博客
06-19 590
在Spring-Boot项目开发中，存在着本模块的代码需要访问外面模块接口，或外部url链接的需求, 比如在apaas开发过程中需要封装接口在接口中调用apaas提供的接口（像发起流程接口submit等等）下面也是提供了三种方式（不使用dubbo的方式）供我们选择。Post请求提供有postForEntity、postForObject和postForLocation三种方式，其中每种方式都有三种方法，下面介绍postForEntity的使用方法。定义controller。定义controller。
17. Spring Boot普通类调用bean【从零开始学Spring Boot】
08-13
NULL 博文链接：https://412887952-qq-com.iteye.com/blog/2292388
spring boot源码
05-10
spring boot源代码，通过源代码可以了解spring boot底层运行机制。 1. 初始化各种属性，加载成对象  读取环境属性（Environment）  系统配置（spring.factories）  参数（Arguments、application.properties） 2. 创建Spring容器对象ApplicationContext，加载各种配置 3. 在容器创建前，通过监听器机制，应对不同阶段加载数据、更新数据的需求 4. 容器初始化过程中追加各种功能，例如统计时间、输出日志等 监听器类型 1. 在应用运行但未进行任何处理时，将发送 ApplicationStartingEvent。 2. 当Environment被使用，且上下文创建之前，将发送 ApplicationEnvironmentPreparedEvent。 3. 在开始刷新之前，bean定义被加载之后发送 ApplicationPreparedEvent。 4. 在上下文刷新之后且所有的应用和命令行运行器被调用之前发送 ApplicationStartedEvent。 5. 在应用程序和命令行运行
Spring Boot中Bean定义方调用方式解析
08-18
主要介绍了Spring Boot中Bean定义方调用方式解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
SpringBoot项目打包分离高阶操作
Record Little
04-23 655
虽然传输jar包 比较大，但是安全性、稳定性比较高，不需要关注pom.xml 添加了新的依赖、更新了版本号等等影响版本功能的操作。关注maven的特性， profiles即可满足， 根据不同的activation 状态，激活不同的build操作。每次修改一小部分代码或仅仅更新某个依赖jar包时，都需要重新进行整个项目的构建、打包、上传和部署。但是当你的项目趋于稳定，只有业务上的逻辑变更时，如果使用分离版本，可以加快迭代、更新的速度。弊端： 需要配置IDE命令，修改依赖时需要同时修改2处。
mysql-connector-java和spring-boot-starter-jdbc和mybatis-spring-boot-start
xzy的博客
04-23 970
JDBC是使用java语言操作mysql数据库的规范，java语言必须按照这个规范写才可以操作mysql数据库。
SpringCloudAlibaba：2.1nacos
最新发布
m0_63040701的博客
04-26 715
Nacos是阿里巴巴开源的服务注册中心以及配置中心Nacos=注册中心Eureka + 服务配置Config + 服务总线Bus。
SpringBoot JPA使用
gochenguowei的博客
04-25 929
是 Spring 框架提供的一个模块，用于简化与关系型数据库的交互和数据访问。它基于JPA（Java Persistence API）标准，并提供了一组易于使用的API和工具，帮助开发人员更轻松地进行数据库操作。通过Spring Data JPA，开发人员可以通过编写简洁的代码来执行常见的 CRUD 操作，同时还支持高级查询、分页、事务管理等功能。它的目标是提供一种更简单、更高效的方式来处理数据库操作，减少开发人员的工作量，并提高应用程序的可维护性和可扩展性。
每日一题：Spring 框架中都用到了哪些设计模式❓
lhcong_的博客
04-24 297
总之，Spring 框架中充分利用了许多设计模式，提供了良好的扩展性和灵活性，降低了代码的耦合度，提高了代码的可维护性。
springboot gradle 调用子模块bean
05-30
要在 Spring Boot Gradle 项目中调用子模块的 Bean，可以按照以下步骤进行操作： 1. 在父模块的 build.gradle 文件中添加依赖项： ``` dependencies { implementation project(':子模块名称') } ``` 2. 在子模块...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值