Spring Boot 使用总结
最近做的项目用到了Spring Boot和Spring Cloud,也算是接触了微服务的一些东西,趁着这两天有时间写一点东西来记录一下。
目录:
项目环境搭建
Spring Boot提供了很丰富的项目启动服务,这篇以一个简单的Hello World为例写一下项目启动的方法吧。我平时用到的项目启动方法有3种,以下3种任选其一即可。
Spring Initializer
Spring Initializer是Spring Boot官方提供的一个项目启动方案,初学者可以直接从这里用图形化界面启动自己的项目。这是目前比较推荐的方法。
在这里选好了各种配置项后直接点击Generate Project就可以了,然后下载项目,解压到自己喜欢的目录就可以开始工作了。IDEA Spring Initializer
IDEA天然支持Spring Initializer,可以直接在新建项目的时候在IDE中使用Spring Initializer。这也是目前比较推荐的方法。
在新建项目的时候选择Spring Initializer,不停的下一步就可以了。
最后一种方法是用最简单的新建项目的方法,新建一个Maven工程,然后将maven的父项目设置为Spring Boot即可。
编写代码
controller是Spring MVC结构中的一个,M是Model,V是View,C就是Controller,有关MVC的详细资料这里不再多说,可以自行百度。Controller是控制器的意思,在这里作为整个系统对外的交互层,即系统对外的一个门面。所有RESTful的接口都在这里定义(RESTful是一种接口风格,这里也不多做解释)。
首先新建一个package,然后在package里新建一个class。这里多说一下,将项目按照标准结构分门别类是一个很好的编程习惯,我平常用到的package有controller(负责一切对外事宜),service(内部的服务处理,把controller收到的请求都送到这里来进行相应的流程),dao(数据库的dao),entity(数据库的entity),component(一些不知道放哪里的小class,如各种enum之类),util(通用处理工具,如各种数据转换的类)等,希望各位大佬看到了觉得有可以改进的地方能跟我多交流一下。
新建了一个TestController类后,首先在class的上面加上@RestController注解,这个注解的作用是把下面这个类标注为一个Controller,让Spring可以找到,然后把其中的方法mapping到相应的接口。
在类中定义一个函数hello,这里用到了两个注解,一个是@GetMapping,这个注解的作用的是将下面这个函数映射到一个名为hello的接口,且指定了访问方法为Http GET。可以用@RequestMapping达到相同的效果。另一个注解是@RequestParam,这个注解的作用是将请求中附带的参数映射到后面的这个函数接口参数中,value指定了请求中的参数名称。
注意:我这里将函数名和参数写成test是为了和注解中的参数区别开来,方便新手更快的找到每个不同的设置的作用域,实际项目中起名时应该起具有明确意义的名字
以下是class的实际代码
package com.example.blog.controller;
import org.springframework.web.bind.annotation.*;
@RestController
public class TestController {
/**
* 测试函数
* @param test 名称
* @return 打招呼
*/
@GetMapping(value = "hello")
//@RequestMapping(value = "hello",method = RequestMethod.GET)
public String test(@RequestParam(value = "name")String test) {
return "Hello" + test;
}
}
到了这里一个简单的Demo就搭建好了,现在把项目跑起来,打开浏览器在地址栏输入http://localhost:8080/hello?name=小明 ,可以看到浏览器返回了打招呼的响应。
完整项目
项目结构
Maven配置
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>blog</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>blog</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>