工程说明

本文主要就下述主题进行说明：

• 框架背景
• 工程类型
• 工程结构
• 工程日志
• Servlet 容器

框架背景

SOFABoot 基于 Spring Boot 框架开发，并依赖 Apache Maven 进行构建。SOFABoot 和 Spring Boot 版本对应关系，以及 JDK 和 Maven 版本要求如下：

工程类型

SOFABoot 使用 Maven 作为构建工具来创建和管理工程，支持创建以下两种类型的工程：

• SOFABoot Web：基于 Spring Boot 进行扩展的 Web 工程，通常用于需要 Web 页面展现的应用。另外，结合中间件 SOFAREST 服务，可提供基于 JAX-RS（Java API for RESTful Web Services） 标准的前后端分离解决方案。
• SOFABoot Core：基于 Spring Boot 进行扩展的 Java 工程，通常用于实现无页面展现的后端服务。

工程结构

在开始使用 SOFABoot 之前，您可以通过本文先了解 SOFABoot 两种工程类型的目录结构：

• Web 工程原型目录
• Core 工程原型目录

为了更好的理解目录结构，本文中的工程依赖为：

• groupId：com.alipay.sofa
• artifactId：APPNAME

Web 工程原型目录

Web 工程模型默认生成 endpoint 和 web 两个模块：

• endpoint 模块：SOFAREST 的服务模块，对外提供 SOFAREST 服务。
• web 模块：包含 main 函数的启动模块，可以直接运行。另外，还包含全局配置文件、测试模块和静态资源等。

使用 Maven 命令创建的 Web 工程目录结构如下：

├── app
│   ├── endpoint
│   │   ├── pom.xml
│   │   └── src
│   │       └── main
│   │           ├── java
│   │           │   └── com
│   │           │       └── alipay
│   │           │           └── APPNAME
│   │           │               └── endpoint => SOFAREST 实践代码
│   │           │                   ├── constants
│   │           │                   │   ├── RestConstants.java
│   │           │                   │   └── URLConstants.java
│   │           │                   ├── exception
│   │           │                   │   ├── CommonException.java
│   │           │                   │   └── SofaRestExceptionHandler.java
│   │           │                   ├── facade
│   │           │                   │   └── SampleRestFacade.java
│   │           │                   ├── filter
│   │           │                   │   └── CommonContainerResponseFilter.java
│   │           │                   ├── impl
│   │           │                   │   └── SampleRestFacadeRestImpl.java
│   │           │                   ├── model
│   │           │                   │   └── DemoUserModel.java
│   │           │                   └── response
│   │           │                       ├── AbstractFacadeResp.java
│   │           │                       └── RestSampleFacadeResp.java
│   │           └── resources
│   │               └── META-INF
│   │                   └── APPNAME
│   │                       └── APPNAME-endpoint.xml
│   └── web
│       ├── pom.xml
│       └── src
│           ├── main
│           │   ├── java
│           │   │   └── com
│           │   │       └── alipay
│           │   │           └── APPNAME
│           │   │               └── Slite2WebSpringBootApplication.java => 启动函数
│           │   └── resources
│           │       ├── META-INF
│           │       │   └── APPNAME => Spring 配置文件存放处，放到指定的 APPNAME 目录下
│           │       │       └── APPNAME-web.xml
│           │       ├── config => 配置目录，详见「配置解决方案」
│           │       │   └── application.properties => 应用的日志配置文件
│           │       │   └── application-dev.properties
│           │       │   └── application-test.properties
│           │       ├── logback-spring.xml => 应用的日志配置文件
│           │       └── static => WEB 工程的静态页面存放处
│           │           └── index.html
│           └── test => 应用的测试模块，内置启动了 Spring Boot，方便业务测试
│               └── java
│                   └── com
│                       └── alipay
│                           └── APPNAME
│                               └── web
│                                   └── test
│                                       ├── base
│                                       │   └── AbstractTestBase.java
│                                       └── usercases
│                                           └── SofaRestServiceTest.java
└── pom.xml => 应用的 Maven 配置文件

说明：

• 默认情况下，静态页面都存放至 src/main/resources/static 目录下以进行统一管理。
• SOFABoot 的全局属性配置解决方案和日志配置解决方案，请参考 SOFABoot 技术栈的 配置解决方案。
• 应用的测试模块，在 web 模块的 src/test/java 目录下，测试用例包含一个测试基类（base）和一个测试类（usercases），测试类中启动了 Spring Boot 进行 SOFAREST 的简单功能测试。

Core 工程原型目录

根据实际应用名称，Core 工程模型会默认生成 {APPNAME}-facade 和 {APPNAME}-service 两个模块：

• facade 模块：定义应用的接口依赖包。
• service 模块：包含 main 函数的启动模块，可以直接运行。另外，还包含全局配置文件和测试模块。以 groupId=com.alipay.sofa、artifactId=APPNAME 为例，使用 Maven 命令创建的 Core 工程目录结构如下：

├── APPNAME-facade
│   ├── pom.xml
│   └── src => 当前应用用于分发给其他应用的接口依赖包
│       └── main
│           └── java
│               └── com
│                   └── alipay
│                       └── APPNAME
│                           └── facade
│                               └── SampleService.java
├── APPNAME-service
│   ├── pom.xml
│   └── src
│       ├── main
│       │   ├── java
│       │   │   └── com
│       │   │       └── alipay
│       │   │           └── APPNAME
│       │   │               ├── Slite2SpringBootAPPNAMEApplication.java => 启动函数
│       │   │               └── service
│       │   │                   └── SampleServiceImpl.java
│       │   └── resources
│       │       ├── META-INF
│       │       │   └── APPNAME => Spring 配置文件存放处，放到指定的 APPNAME 目录下
│       │       │       └── APPNAME-service.xml
│       │       ├── config => 配置目录，详见「配置解决方案」
│       │       │   ├── application-dev.properties
│       │       │   ├── application-test.properties
│       │       │   └── application.properties
│       │       └── logback-spring.xml => 应用的日志配置文件
│       └── test => 应用的测试模块，内置启动了 Spring Boot 方便业务测试
│           ├── java
│           │   └── com
│           │       └── alipay
│           │           └── APPNAME
│           │               └── test
│           │                   ├── base
│           │                   │   └── AbstractTestBase.java
│           │                   └── usercases
│           │                       └── BeanTest.java
│           └── resources
│               └── test
│                   └── META-INF
│                       └── APPNAME
│                           └── test.xml
└── pom.xml => 应用的 Maven 配置文件

说明：

• SOFABoot 的全局属性配置解决方案和日志配置解决方案，请参考 SOFABoot 技术栈的 配置解决方案。
• 应用的测试模块，在 service 模块的 src/test/java 目录下，测试用例包含一个测试基类（base）和一个测试类（usercases）。测试类中启动了 Spring Boot 进行 bean 的简单功能测试。

工程日志

详情参见 工程日志。

Servlet 容器

SOFABoot 内嵌以下容器，开箱即用：