JeecgBoot框架升級至Spring?Boot3的實戰(zhàn)步驟

更新時間：2024年04月12日 11:16:18 作者：JEECG低代碼平臺

本文主要介紹了JeecgBoot框架升級至Spring?Boot3的實戰(zhàn)步驟，從?2.7.10升級到3.1.5有以下幾個點需要注意，下面就來詳細的介紹一下，感興趣的可以了解一下

Spring Boot

從 2.7.10升級到3.1.5有以下幾個點需要注意。

JDK版本支持從JDK 17-19版本
javax.servlet切換到j(luò)akarta.servlet
spring.redis配置切換為spring.data.redis
Spring Cloud 2022.0.4
Spring Cloud Alibaba 2022.0.0.0

除以上三點外，其它都是平滑升級，不過這也只是相對于我們應(yīng)用Spring Boot的用戶來說。不過對于第二點，屬于是破壞性升級了，需要將項目中引用的javax.servlet替換成jakarta.servlet。

spring boot升級參考文檔：https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-3.0-Migration-Guide

spring cloud升級參考文檔：https://docs.spring.io/spring-cloud/docs/current/reference/html/

spring cloud alibaba升級參考文檔：https://sca.aliyun.com/zh-cn/docs/2022.0.0.0/overview/version-explain

Shiro

前面講到由于Spring Boot內(nèi)部的servlet包換掉了，jeecg框架使用shiro以及spring boot集成，所以shiro需要升級，不過還好shiro官方給這個點提供了支持，以下是shiro的升級替換。

需要注意的是，spring boot 3.1.5對jedis的版本做了提升，提升后shiro無法兼容，所以只能在項目進行降版本處理。

shiro升級參考文檔：http://www.dbjr.com.cn/program/319485h0o.htm

<!--shiro-->
		<dependency>
			<groupId>org.apache.shiro</groupId>
			<artifactId>shiro-spring-boot-starter</artifactId>
			<version>${shiro.version}</version>
			<exclusions>
				<exclusion>
					<groupId>org.apache.shiro</groupId>
					<artifactId>shiro-spring</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
		<!-- shiro-redis -->
		<dependency>
			<groupId>org.crazycake</groupId>
			<artifactId>shiro-redis</artifactId>
			<version>${shiro-redis.version}</version>
			<exclusions>
				<exclusion>
					<groupId>org.apache.shiro</groupId>
					<artifactId>shiro-core</artifactId>
				</exclusion>
				<exclusion>
					<artifactId>checkstyle</artifactId>
					<groupId>com.puppycrawl.tools</groupId>
				</exclusion>
			</exclusions>
		</dependency>
		<!-- shiro 無法使用 spring boot 3.X 自帶的jedis，降版本處理 -->
		<dependency>
			<groupId>redis.clients</groupId>
			<artifactId>jedis</artifactId>
			<version>2.9.0</version>
		</dependency>

		<dependency>
			<groupId>org.apache.shiro</groupId>
			<artifactId>shiro-spring</artifactId>
			<classifier>jakarta</classifier>
			<version>${shiro.version}</version>
			<!-- 排除仍使用了javax.servlet的依賴 -->
			<exclusions>
				<exclusion>
					<groupId>org.apache.shiro</groupId>
					<artifactId>shiro-core</artifactId>
				</exclusion>
				<exclusion>
					<groupId>org.apache.shiro</groupId>
					<artifactId>shiro-web</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
		<!-- 引入適配jakarta的依賴包 -->
		<dependency>
			<groupId>org.apache.shiro</groupId>
			<artifactId>shiro-core</artifactId>
			<classifier>jakarta</classifier>
			<version>${shiro.version}</version>
		</dependency>
		<dependency>
			<groupId>org.apache.shiro</groupId>
			<artifactId>shiro-web</artifactId>
			<classifier>jakarta</classifier>
			<version>${shiro.version}</version>
			<exclusions>
				<exclusion>
					<groupId>org.apache.shiro</groupId>
					<artifactId>shiro-core</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

knife4j

knife4j對于spring boot 3.X版本提供了支持，不過相當(dāng)于spring boot 2.X的版本來說，差異比較大，從springfox轉(zhuǎn)換成了springdoc，不能做到平滑升級，以下是需要替換的注解列表.

knife4j升級參考文檔：

https://doc.xiaominfo.com/docs/quick-start/start-knife4j-version#22-spring-boot-3x

https://springdoc.org/#migrating-from-springfox

@Api → @Tag
@ApiIgnore → @Parameter(hidden = true) or @Operation(hidden = true) or @Hidden
@ApiImplicitParam → @Parameter
@ApiImplicitParams → @Parameters
@ApiModel → @Schema
@ApiModelProperty(hidden = true) → @Schema(accessMode = READ_ONLY)
@ApiModelProperty → @Schema
@ApiOperation(value = "foo", notes = "bar") → @Operation(summary = "foo", description = "bar")
@ApiParam → @Parameter
@ApiResponse(code = 404, message = "foo") → @ApiResponse(responseCode = "404", description = "foo")

同樣在初始化文檔對象上也有區(qū)別，以下前后替換

[@Bean](https://my.oschina.net/bean)
    public GroupedOpenApi swaggerOpenApi() {
        return GroupedOpenApi.builder()
                .group("default")
                .packagesToScan("org.jeecg")
                .build();
    }

    [@Bean](https://my.oschina.net/bean)
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("JeecgBoot 后臺服務(wù)API接口文檔")
                        .version("1.0")
                        .contact(new Contact().name("北京國炬信息技術(shù)有限公司").url("www.jeccg.com").email("jeecgos@163.com"))
                        .description( "后臺API接口")
                        .termsOfService("NO terms of service")
                        .license(new License().name("Apache 2.0").url("http://www.apache.org/licenses/LICENSE-2.0.html"))
                );
    }


// ---------------------------替換后---------------------

    [@Bean](https://my.oschina.net/bean)
    public GroupedOpenApi swaggerOpenApi() {
        return GroupedOpenApi.builder()
                .group("default")
                .packagesToScan("org.jeecg")
                .build();
    }

    [@Bean](https://my.oschina.net/bean)
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("JeecgBoot 后臺服務(wù)API接口文檔")
                        .version("1.0")
                        .contact(new Contact().name("北京國炬信息技術(shù)有限公司").url("www.jeccg.com").email("jeecgos@163.com"))
                        .description( "后臺API接口")
                        .termsOfService("NO terms of service")
                        .license(new License().name("Apache 2.0").url("http://www.apache.org/licenses/LICENSE-2.0.html"))
                );
    }

升級的maven地址：

		<dependency>
			<groupId>com.github.xiaoymin</groupId>
			<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
			<version>4.3.0</version>
		</dependency>

在knife4j 4.X版本中，首次在對swagger文檔與spring cloud gateway進行了整合，提供完整的解決方案，做到了開箱即用，以下是應(yīng)用案例，在jeecg中也得到了升級。

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-gateway-spring-boot-starter</artifactId>
            <version>4.3.0</version>
        </dependency>

spring boot 3.x 生態(tài)增強平滑升級

以下為平滑升級，即更換版本即可，不需要做任何調(diào)整，jeecg框架調(diào)整如下

		<!-- druid -->
		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>druid-spring-boot-3-starter</artifactId>
			<version>1.2.20</version>
		</dependency>

		<!-- 動態(tài)數(shù)據(jù)源 -->
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>dynamic-datasource-spring-boot3-starter</artifactId>
			<version>4.1.3</version>
		</dependency>

		<!-- spring boot-admin -->
		<dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-starter-server</artifactId>
            <version>3.0.4</version>
        </dependency>