我们将通过一个简单的 Demo 来阐述 Shoulder-Framework 的强大功能,在此之前,我们假设您已经:

  • 拥有 Java 开发环境以及相应 IDE (JDK 17+、Maven 3.6+)

  • 熟悉 Spring Boot

  • 熟悉 Maven 或 Gradle

初始化工程

方式一:一行命令开始(简单)

可以运行以下命令快速创建一个 Shoulder 工程,Shoulder 将自动管理其依赖版本,同时已为您创建好目录结构。
mvn archetype:generate \
  -DarchetypeGroupId=cn.itlym \
  -DarchetypeArtifactId=shoulder-archetype-simple \
  -DarchetypeVersion=0.8.1 \
  -DgroupId=com.yourcompany \
  -DartifactId=yourappName \
  -Dversion=1.0-SNAPSHOT

方式二:在 Spring Boot 项目中使用(可选)

如您已创建好 Spring-Boot 工程,您只需要在 pom.xml 中加入以下内容,即可享受 shoulder-web 带来的增强的啦。

Maven
<dependency>
    <groupId>cn.itlym</groupId>
    <artifactId>shoulder-starter-web</artifactId>
    <version>0.8.1<version>
</dependency>
Gradle
compile 'cn.itlym:shoulder-starter-web:0.8.1'
  • Shoulder 作为 Spring Boot 的插件,您自然可以像其他 starter 一样无缝集成使用。

  • 推荐第一种创建方式,免去了输入 Spring-BootShoulder 相关依赖版本号的麻烦,且无需担心 jar 版本冲突、不兼容等问题。

配置

不需要任何配置,直接启动运行即可。

如同 Spring-Boot,约定大于配置。

编码

您可以尝试将以下内容复制进您的工程并运行查看。

Java
// imports...

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("rest")
public class MyRestController {
    @GetMapping("hello")
    public String hello() {
        return "shoulder";
    }
}
Kotlin
// imports...

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("rest")
class MyRestController {
	@GetMapping("hello")
	fun hello(): String {
		return "shoulder"
	}
}
Shoulder 只是 Spring Boot 一个增强的 插件,实际您运行的仍然是 Spring Boot 应用,所有使用完全同 Spring Boot

小结

通过一行命令,我们就实现了 Shoulder 的启动,甚至一行配置都不需要!

集成 Shoulder 非常的简单,只需要引入依赖即可使用!

Shoulder 的强大远不止这些功能,想要详细了解 Shoulder 的强大功能?那就继续往下看吧!

跟着 Demo 快速认识 Shoulder