diff --git a/Tutorial/README.md b/Tutorial/README.md new file mode 100644 index 0000000..6582337 --- /dev/null +++ b/Tutorial/README.md @@ -0,0 +1,12 @@ +# 简介 + +Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications that you can “just run”. We take an opinionated view of the Spring platform and third-party libraries so you can get started with minimum fuss. Most Spring Boot applications need very little Spring configuration. + +You can use Spring Boot to create Java applications that can be started using java -jar or more traditional war deployments. We also provide a command line tool that runs “spring scripts”. + +Our primary goals are: + +- Provide a radically faster and widely accessible getting started experience for all Spring development. +- Be opinionated out of the box, but get out of the way quickly as requirements start to diverge from the defaults. +- Provide a range of non-functional features that are common to large classes of projects (e.g. embedded servers, security, metrics, health checks, externalized configuration). +- Absolutely no code generation and no requirement for XML configuration. diff --git a/Tutorial/SUMMARY.md b/Tutorial/SUMMARY.md new file mode 100644 index 0000000..4bca2b9 --- /dev/null +++ b/Tutorial/SUMMARY.md @@ -0,0 +1,11 @@ +# Summary + +* [简介](README.md) +* [快速入门](chapter1.md) +* [框架详解](chapter2.md) + * 项目构建(chapter2-1.md) + * [工程结构(chapter2-2.md)](chapter2-2.md) +* [数据访问](chapter3.md) +* [Chapter4](chapter4.md) +* [附录1:Starter POMs](appendix1.md) + diff --git a/Tutorial/appendix1.md b/Tutorial/appendix1.md new file mode 100644 index 0000000..e69de29 diff --git a/Tutorial/chapter1-1.png b/Tutorial/chapter1-1.png new file mode 100644 index 0000000..9595185 Binary files /dev/null and b/Tutorial/chapter1-1.png differ diff --git a/Tutorial/chapter1-2.png b/Tutorial/chapter1-2.png new file mode 100644 index 0000000..1ad92f1 Binary files /dev/null and b/Tutorial/chapter1-2.png differ diff --git a/Tutorial/chapter1.md b/Tutorial/chapter1.md new file mode 100644 index 0000000..4636e5b --- /dev/null +++ b/Tutorial/chapter1.md @@ -0,0 +1,153 @@ +# 快速入门 + +本章主要目标完成Spring Boot基础项目的构建，并且实现一个简单的Http请求处理，通过这个例子对Spring Boot有一个初步的了解，并体验其结构简单、开发快速的特性。 + +本书所有章节均采用Spring Boot 1.3.2版本调试通过使用的。 + +## 系统要求： + +#### 框架要求： +- Java 7及以上 +- Spring Framework 4.1.5及以上 + +> 本系列文章均采用`Java 1.8.0_73`编译调试运行所有样例。 + +#### Servlet容器要求 + +推荐使用以下版本的Servlet容器 + +| 名称 | Servlet版本 | Java版本 | +| -- | -- | -- | +| Tomcat 8 | 3.1 | Java 7+ | +| Tomcat 7 | 3.0 | Java 6+ | +| Jetty 9 | 3.1 | Java 7+ | +| Jetty 8 | 3.0 | Java 6+ | +| Undertow 1.1 | 3.1 | Java 7+ | + +当然，你也可以将Spring Boot应用部署在其他支持Servlet 3.0以上的容器中。 + +## 使用Maven构建项目 + +1. 通过`SPRING INITIALIZR`工具产生基础项目 + 1. 访问：`http://start.spring.io/` + 2. 选择构建工具`Maven Project`、Spring Boot版本`1.3.2`以及一些工程基本信息，可参考下图所示![SPRING INITIALIZR](chapter1-1.png) + 3. 点击`Generate Project`下载项目压缩包 +2. 解压项目包，并用IDE以`Maven`项目导入，以`IntelliJ IDEA 14`为例： + 1. 菜单中选择`File`-->`New`-->`Project from Existing Sources...` + 2. 选择解压后的项目文件夹，点击`OK` + 3. 点击`Import project from external model`并选择`Maven`，点击`Next`到底为止。 + 4. 若你的环境有多个版本的JDK，注意到选择`Java SDK`的时候请选择`Java 7`以上的版本 + + +## 项目结构解析 + +![项目结构](chapter1-2.png) + +通过上面步骤完成了基础项目的创建，如上图所示，Spring Boot的基础结构共三个文件（具体路径根据用户生成项目时填写的Group所有差异）： + +- `src/main/java`下的程序入口：`Chapter1Application` +- `src/main/resources`下的配置文件：`application.properties` +- `src/test/`下的测试入口：`Chapter1ApplicationTests` + +生成的`Chapter1Application`和`Chapter1ApplicationTests`类都可以直接运行来启动当前创建的项目，由于目前该项目未配合任何数据访问或Web模块，程序会在加载完Spring之后结束运行。 + + +## 引入Web模块 + +当前的`pom.xml`内容如下，仅引入了两个模块： + +- `spring-boot-starter`：核心模块，包括自动配置支持、日志和YAML +- `spring-boot-starter-test`：测试模块，包括JUnit、Hamcrest、Mockito + +```xml + + + org.springframework.boot + spring-boot-starter + + + + org.springframework.boot + spring-boot-starter-test + test + + +``` + +引入Web模块，需添加`spring-boot-starter-web`模块： + +```xml + + org.springframework.boot + spring-boot-starter-web + +``` + +更多starter模块可见`附件1:Starter POMs` + +## 编写HelloWorld服务 + +- 创建`package`命名为`com.didispace.web`（根据实际情况修改） +- 创建`HelloController`类，内容如下 + +```java +@RestController +public class HelloController { + + @RequestMapping("/hello") + public String index() { + return "Hello World"; + } + +} + +``` + +- 启动主程序，打开浏览器访问`http://localhost:8080/hello`，可以看到页面输出`Hello World` + + +## 编写单元测试用例 + + +打开的`src/test/`下的测试入口`Chapter1ApplicationTests`类。下面编写一个简单的单元测试来模拟http请求，具体如下： + +```java +@RunWith(SpringJUnit4ClassRunner.class) +@SpringApplicationConfiguration(classes = MockServletContext.class) +@WebAppConfiguration +public class Chapter1ApplicationTests { + + private MockMvc mvc; + + @Before + public void setUp() throws Exception { + mvc = MockMvcBuilders.standaloneSetup(new HelloController()).build(); + } + + @Test + public void getHello() throws Exception { + mvc.perform(MockMvcRequestBuilders.get("/hello").accept(MediaType.APPLICATION_JSON)) + .andExpect(status().isOk()) + .andExpect(content().string(equalTo("Hello World"))); + } + +} +``` + +使用`MockServletContext`来构建一个空的`WebApplicationContext`，这样我们创建的`HelloController`就可以在`@Before`函数中创建并传递到`MockMvcBuilders.standaloneSetup（）`函数中。 + + +- 注意引入下面内容，让`status`、`content`、`equalTo`函数可用 + +```java +import static org.hamcrest.Matchers.equalTo; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; +``` + +至此已完成本章目标，通过Maven构建了一个空白Spring Boot项目，再通过引入web模块实现了一个简单的请求处理。 + + + + + diff --git a/Tutorial/chapter2-2.md b/Tutorial/chapter2-2.md new file mode 100644 index 0000000..994dffe --- /dev/null +++ b/Tutorial/chapter2-2.md @@ -0,0 +1,28 @@ +# 工程结构 + +Spring Boot本身并没有对工程结构有特别的要求，但是一些最佳实践的工程结构可以参考学习和使用。 + + +## 典型示例 + + + +``` +com + +- example + +- myproject + +- Application.java + | + +- domain + | + | + | + +- service + | + | + +- web + | + | + +``` + diff --git a/Tutorial/chapter2.md b/Tutorial/chapter2.md new file mode 100644 index 0000000..e69de29