跳到主要内容

Spring Boot

在ChatGPT中打开

Spring Boot 是构建 Java 应用的热门选择,提供依赖注入、自动配置和嵌入式服务器模型。当将 Spring Boot 与 webforJ 结合使用时,您可以通过构造函数注入直接将服务、存储库以及其他 Spring 管理的 bean 注入到您的 UI 组件中。

当您将 Spring Boot 与 webforJ 结合使用时,您的应用作为一个可执行的 JAR 文件运行,并采用嵌入式 Tomcat 服务器,而不是将 WAR 文件部署到外部应用服务器。这种打包模型简化了部署,并符合云原生部署实践。webforJ 的组件模型和路由与 Spring 的应用上下文一同工作,以管理依赖关系和配置。

创建 Spring Boot 应用

您有两种选项可以使用 Spring Boot 创建新 webforJ 应用:使用图形界面的 startforJ 工具或 Maven 命令行。

选项 1:使用 startforJ

创建新 webforJ 应用最简单的方法是 startforJ,该工具根据选择的 webforJ 原型生成一个最小的启动项目。此启动项目包含所有所需的依赖项、配置文件和预制布局,因此您可以立即开始构建。

在使用 startforJ 创建应用时,您可以通过提供以下信息进行自定义:

  • 基本项目元数据(应用名称、组 ID、工件 ID)
  • webforJ 版本和 Java 版本
  • 主题颜色和图标
  • 原型
  • Flavor - 选择 webforJ Spring 以创建 Spring Boot 项目

使用这些信息,startforJ 将根据您选择的原型创建一个为 Spring Boot 配置的基本项目。您可以选择将项目作为 ZIP 文件下载,或者直接发布到 GitHub。

选项 2:使用命令行

如果您更喜欢使用命令行,可以直接使用官方 webforJ 原型生成一个 Spring Boot webforJ 项目:

mvn -B archetype:generate \
-DarchetypeGroupId=com.webforj \
-DarchetypeArtifactId=webforj-archetype-hello-world \
-DarchetypeVersion=LATEST \
-DgroupId=org.example \
-DartifactId=my-app \
-Dversion=1.0-SNAPSHOT \
-Dflavor=webforj-spring

flavor 参数指示原型生成一个 Spring Boot 项目,而不是标准的 webforJ 项目。

这将创建一个完整的 Spring Boot 项目,包含:

  • Spring Boot 父 POM 配置
  • webforJ Spring Boot 启动器依赖
  • 带有 @SpringBootApplication@Routify 的主应用类
  • 示例视图
  • Spring 和 webforJ 的配置文件

将 Spring Boot 添加到现有项目

如果您有现有的 webforJ 应用,可以通过修改项目配置来添加 Spring Boot。此过程涉及更新 Maven 配置、添加 Spring 依赖项以及转换主应用类。

仅适用于现有项目

如果您正在从头创建新项目,请跳过此部分。

步骤 1:更新 Maven 配置

请对您的 POM 文件进行以下更改:

  1. 将打包方式从 WAR 更改为 JAR:

    pom.xml
    <packaging>jar</packaging>
  2. 将 Spring Boot 设置为父 POM:

    pom.xml
    <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>3.5.3</version>
    <relativePath/>
    </parent>
  3. 删除任何与 WAR 相关的配置,例如:

    • maven-war-plugin
    • webapp 目录引用
    • web.xml 相关的配置

如果您已经有父 POM,您需要导入 Spring Boot 材料清单(BOM):

pom.xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>3.5.3</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

步骤 2:添加 Spring 依赖项

将 webforJ Spring Boot 启动器添加到您的依赖项中。保留您现有的 webforJ 依赖:

pom.xml
<dependencies>
<!-- 您现有的 webforJ 依赖 -->
<dependency>
<groupId>com.webforj</groupId>
<artifactId>webforj</artifactId>
<version>${webforj.version}</version>
</dependency>

<!-- 添加 Spring Boot 启动器 -->
<dependency>
<groupId>com.webforj</groupId>
<artifactId>webforj-spring-boot-starter</artifactId>
<version>${webforj.version}</version>
</dependency>

<!-- 添加开发工具 -->
<dependency>
<groupId>com.webforj</groupId>
<artifactId>webforj-spring-devtools</artifactId>
<optional>true</optional>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
webforJ DevTools 用于自动浏览器刷新

webforj-spring-devtools 依赖扩展了 Spring DevTools 的自动浏览器刷新功能。当您在 IDE 中保存更改时,浏览器会自动重新加载,无需手动干预。有关配置的详细信息,请参阅 Spring DevTools 指南。

步骤 3:更新构建插件

用 Spring Boot Maven 插件替换 Jetty 插件。删除任何现有的 Jetty 配置,并添加:

pom.xml
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludeDevtools>true</excludeDevtools>
</configuration>
</plugin>
</plugins>
</build>

步骤 4:转换您的应用类

通过添加必要的 Spring 注解和主方法,将主 App 类转换为 Spring Boot 应用:

Application.java
package com.example;

import com.webforj.App;
import com.webforj.annotation.Routify;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@Routify(packages = "com.example.views")
public class Application extends App {

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

// 如果您有现有的 run() 方法,请保留它
@Override
public void run() throws WebforjException {
// 您现有的初始化代码
}
}

@SpringBootApplication 注解启用了 Spring 的自动配置和组件扫描。@Routify 注解保持不变,继续扫描您的视图包以获取路由。

步骤 5:添加 Spring 配置

src/main/resources 中创建 application.properties

application.properties
# 应用名称
spring.application.name=Hello World Spring

# 服务器配置
server.port=8080
server.shutdown=immediate

# webforJ DevTools 配置
spring.devtools.livereload.enabled=false
webforj.devtools.livereload.enabled=true
webforj.devtools.livereload.static-resources-enabled=true

您现有的 webforj.conf 文件继续工作。将其指向您的主类:

webforj.conf
webforj.entry = org.example.Application

运行 Spring Boot 应用

配置完成后,使用以下命令运行您的应用:

mvn spring-boot:run

应用默认在 8080 端口上以嵌入式 Tomcat 服务器启动。您现有的 webforJ 视图和路由像以前一样正常工作,但现在您可以注入 Spring beans 并使用 Spring 功能。

配置差异

当您切换到 Spring Boot 时,几个配置方面会发生变化:

方面标准 webforJSpring Boot webforJ
打包WAR 文件可执行 JAR
服务器外部(Jetty,Tomcat)嵌入式 Tomcat
运行命令mvn jetty:runmvn spring-boot:run
主配置webforj.confwebforj.conf + application.properties
配置文件webforj-dev.confwebforj-prod.conf带有 application-{profile}.properties 的 Spring 配置文件
端口配置在插件配置中server.port 在属性中