第一篇：SpringBoot项目的创建和开发

    <mirror>
      <id>alimaven</id>
      <name>aliyun maven</name>
  　　<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
      <mirrorOf>central</mirrorOf>        
    </mirror>

新建maven项目

这里设置项目的名称和地址，以及项目坐标的GAV(保证项目唯一性)，测试用坐标不配也行。

进入编辑环境中，打开设置将idea默认配置的maven改为自己下载的maven。第一是maven解压的路径，第二是settings.xml配置文件位置，点击覆盖，选择对应的配置文件。最后是自己创建和配置的本地仓库位置。

2 SpringBoot介绍与项目创建

2.1 SpringBoot介绍

SpringBoot是由Pivotal团队提供的基于Spring的全新框架，旨在简化Spring应用的初始搭建和开发过程。Java开发企业级应用一般会涉及到三个框架，Spring、SpringMVC和Mybatis，也就是SSM，其开发特点是配置特别繁琐，涉及大量的xml文件。

SpringBoot的设计目标就是使开发者能够更轻松地创建独立的、基于Spring的应用程序，而无需过多的配置。尽可能地简化应用开发的门槛，让应用开发、测试、部署变得更加简单。

SpringBoot特点：

自动配置：遵循"约定优于配置的原则"，只需要很少的配置或使用默认的配置。

嵌入式服务器：提供内嵌的Tomcat、Jetty服务器。

起步依赖：提供定制化的启动器Starters，简化Maven配置，开箱即用。

简化的配置：Spring Boot采用了简化的配置方式，使用了属性文件（如application.properties或application.yml）来配置应用程序。这种方式使得配置更易于理解和管理。

Actuator：Actuator可以提供对应用程序的运行时指标、健康检查、日志记录、性能监视等功能，对于应用程序的运维和监控非常有帮助。

2.2 快速创建SpringBoot项目

利用IDEA提供的Spring Initializr通过SpringBoot框架搭建应用程序。

GAV：

Group：一般输入公司域名的倒置

Artifact：项目名称

通过安装Web项目相关的依赖，如SpringMVC。

有时候进去后发现maven插件的依赖飘红，这是因为springboot与maven插件版本冲突问题，springboot版本与maven从父工程parent中引入的默认版本发生冲突，修改springboot版本或者maven版本即可。但是有时候可能只是IDEA的问题，重启一下就好。

以下是一些项目结构中较重要的目录文件，其中static和templates目录文件在前后端混合开发时会使用，在前后端分离项目中就不需要了。

2.3 开发环境热部署

在实际的项目开发调试过程中会频繁地修改后台类文件，导致需要重新编译、重新运行，整个过程非常麻烦，影响开发效率。SpringBoot提供了spring-boot-devtools组件，devtools会监听classpath下的文件变动，触发Restart类加载器重新加载该类，从而实现类文件和属性文件的热部署。使得无需动手重启SpringBoot应用即可重新编译、启动项目，大大缩短启动的时间。并不是所有的更改都需要重启应用，如静态资源、视图模板的修改可通过设置spring.devtools.restart.exclude属性来指定一些文件或目录的修改不用重启应用。

首先在pom.xml中添加spring-boot-devtools的依赖坐标，然如果需要进一步配置可以在application.propertie配置文件中添加配置信息，如设置spring.devtools.restart.exclude属性来指定一些文件或目录的修改不用重启应用。

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <version>2.4.0</version>
        </dependency>

然后打开Settings页面在左边栏找到Buid,Execution,Deployment下的Compile，勾选Build project automatically。确认后再按"Ctrl+Shift+Alt+/"快捷键弹Maintenance维护页面，单击Registry，勾选compile.automake.allow.when.app.running复选框，在新版里此选项放在了settings下advanced settings中。做完后若在IDEA中修改代码，则项目会自动重启。

2.4 系统配置

在application.properties中可以对springboot项目信息进行配置，如服务器端口、数据库连接等配置，以键值对的方式进行配置，如：

server.port=7777

3 Controller

控制器Controller基于Servlet服务程序，也可以说Controller类似于Servlet。Controller和Servlet都是用来接收客户端发送的请求消息request，以及返回给客户端响应消息response的服务程序。运行在容器中(如Tomcat、Jetty服务器等)，容器会根据请求路径将其分配给对应的Controller或者Servlet进行处理，后将处理结果作为响应消息发送回客户端。

3.1 Web入门

SpringBoot将传统Web开发的mvc、json、tomcat等框架整合，提供了spring-boot-starter-web组件，简化了Web应用配置。

创建SpringBoot项目勾选SpringWeb选项后，会自动将spring-boot-starter-web组件加入到项目中。

spring-boot-starter-web启动器主要包括web、webmvc、json、tomcat等基础依赖组件，作用是提供Web开发场景所需的所有底层依赖。

webmvc为Web开发的基础，json为json数据解析组件，tomcat为自带的容器依赖。

3.2 控制器

SpringBoot提供了@Controller和@RestController两种注解来标识此类负责接收和处理HTTP请求。如果请求的是页面和数据，使用@controller注解；如果只是请求数据，则使用@RestController注解即可。@Controller一般在前后端混合开发中使用，需要同时响应页面和数据。而@RestController在前后端分离开发中使用，因为页面都交给了前端，后端只需要响应相关数据。所以主要使用的还是@RestController。

@RestController的用法

默认情况下，@RestController注解会将响应的对象数据转换为json格式。如以下返回一个user对象，该对象会以json字符串的形式响应给前端处理。

@RestController
public class HelloController {
    @GetMapping("/user")
    public User getUser(){
        User user = new User();
        user.setName("Bree");
        user.setPassword("123");
        
        return user;
    }
}

3.3 路由映射

@RestController注解主要负责URL的路径映射。它可以添加在Controller类或者具体的方法上。如果添加在Controller类上，则这个Controller中的所有路由映射都会加上此映射规则，如果添加在方法上，则只对当前方法生效。

@RequestMapping注解包含很多属性参数来定义HTTP的请求映射规则。常用的属性如下：

value：请求URL的路径，支持URL模板、正则表达式。

method：HTTP请求方法，如GET、POST、PUT、DELETE。

consumes：请求的媒体类型（Content-Type），如application/json。

produces：响应的媒体类型。

params，headers：请求的参数和请求头的值。

@RestController
public class HelloController {
    @RequestMapping(value="/getData", mathod = RequestMethod.GET)
    public String getData(){
        return "Hello!";
    }
}

Method匹配也可以使用@GetMapping、@PostMapping等注解代替。

3.4 参数传递和数据响应

@RequestParams

将请求参数绑定到控制器的方法参数上，接收的参数来自HTTP请求体或请求URL的QueryString，当请求的参数名称与Controller的业务方法参数名称一致时，RequestParams可以省略。

可以向服务端传递参数的请求路径为：http://localhost:7777/getData?name=bree&number=1

@RestController
public class HelloController {
    @GetMapping("/getData")
    public String getData(String name, String number){
        return "Hi "+name+", your number is: "+number;
    }
}

还可以定义POST请求接口，并且接收参数。

@RestController
public class HelloController {
    @PostMapping("/postTest")
    public String postTest(String name, String number){
        return "Hi "+name+", your number is "+number;
    }
}

但地址栏只能发送GET请求，不能发送POST请求。可以下载一个调试工具，如Postman、Apipost等。如下图，定义发送的参数数据，或者也可以通过我用Postman向启动的服务端发送请求后得到正常响应，表示服务端已接收到传递的参数，当然，POST请求也可以通过在"?"后传递参数。

@RequestBody

接收的参数是来自requestBody中，即请求消息中的请求体(消息体)。一般用于处理application/json、application/xml编码类型的数据。

JSON对象：Javascript Object Notation，JavaScript对象标记语言，通过JavaScript对象标记法书写的文本。语法简单，结构简明，多用于作为数据载体，在网络中进行数据传输。

定义：var jsonStr = '{ "key01": "Bree", "key02": 21, "arr01": ["男", "女"] }'

JSON字符串转化为JS对象：var jsObj = JSON.parse(jsonStr); JS对象转化为JSON字符串：var jsonStr = JSON.stringify(jsObj);

以下定义POST请求接口，并且接收的参数类型为User类。

@RestController
public class HelloController {
    @PostMapping("/postTest1")
    public String postTest(@RequestBody User user){
        System.out.println(user);
        return "Post请求发送成功";
    }
}

可以看到，通过Postman向服务端发送Post请求，并传递application/json类型数据：json对象。如图成功响应，后端也成功接收到json数据并转换为User类对象打印出来：

@PathVaraible

后面开发RESTful接口时可以可以作为控制器中处理方法的参数，接收处理动态的URL，URL中值。

3.5 Multipart

表单的编码类型enctype属性规定在发送到服务器之应该如何对表单数据进行编码，也就是内容类型content-type。当表单的enctype="application/x-www-form-urlencoded"(默认)时，form表单中的数据格式为：key=value&key=value。

当表单的编码类型enctype="multipart/form-data"时，一个请求中，如Post请求中可以给服务器发送多种类型的数据，可以是文本，也可以是图片或者音视频等等。其传输数据形式如下：

----boundary----
Content-Disposition: form-data; name="foo"

bar
----boundary----
Content-Disposition: form-data; name="baz"

The first line.
The second line.

----boundary----

在这种表单提交的情景下，我们不需要手动设置Content-Type，不用去关系请求消息中的数据是如何排列的，也不需要知道boundary如何分隔，这些都有浏览器来自动完成。

SpringBoot文件上传

Springboot工程嵌入的tomcat限制了请求中的文件大小，每个文件的配置最大为1M，单次请求的文件总数不能大于10M。要更改这个默认值需要在配置文件中加入两个配置：

spring.servlet.mutipart.max-file-size=10M
spring.servlet.mutipart.max-request-size=10M

#保存上传的文件到指定目录下
spring.web.resource.static-locations=/upload/

当表单的enctype="multipart/form-data"时，可以使用MultipartFile类接收上传的文件数据，再通过transferTo方法将其写到磁盘中：

@RestController
public class FileController {
    @PostMapping("/upload")
    public String up(String name, MultipartFile f, HttpServletRequest request) throws Exception {
        System.out.println(name);
        System.out.println(f.getOriginalFilename());
        System.out.println(f.getContentType());
        System.out.println(System.getProperty("user.dir"));

        String path = request.getServletContext().getRealPath("/upload");
        System.out.println(path);
        saveFile(f, path);
        return "上传成功";
    }

    public void saveFile(MultipartFile f, String path) throws Exception {
        File dir = new File(path);
        if(!dir.exists()){
            dir.mkdir();
        }

        File file = new File(path+f.getOriginalFilename());
        f.transferTo(file);
    }
}

3.6 拦截器

拦截器再Web系统中非常常见，对于某些全局统一的操作，我们可以把它提取到拦截器中实现。拦截器其实就是一个servlet接口，服务器会根据请求的URL先找到对应的拦截器，经过判断是否允许进行下一个程序。总结起来，拦截器大致有以下几种使用场景。

权限检查：如登录检测，进入处理程序检测是否登录，如果没有则返回登录页面。

性能监控：有时系统在某段时间莫名其妙很慢，可以通过拦截器在进入程序之前记录开始时间，在处理完后结束时间，从而得到该请求的处理时间等情况。

通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有提取Local、Theme信息等，只要是多个处理程序都需要的，即可以使用拦截器实现。

SpringBoot定义了HandlerInterceptor接口来实现自定义拦截器的功能。HandlerInterceptor接口定义了preHandle、postHandle和afterHandle三种方法，通过重写这三种方法实现请求前、请求后等操作。

拦截器定义，新建登录拦截器类，实现HandlerInterceptor的preHandle方法：

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest req, HttpServletResponse resp, Object handler) throws Exception {
        if(true){
            System.out.println("进入下一个程序");
            return true;
        }else{
            System.out.println("不允许进入下一个程序");
            return false;
        }
    }
}

拦截器也需要通过配置注册到服务器中，类似于定义了一个Servlet类，然后在web.xml中添加Servlet配置信息，便于服务器读取配置的servlet对应的信息数据，当这一步骤没有出错并且完成之后，项目才能正常地被启动起来：

@Configuration
public class WebConfigurer implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry){
        registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/user/**")
    }
}

其中：

addPathPatterns方法定义拦截的路由。

excludePathPatterns定义排除某些地址不被拦截。

添加的一个拦截器没有addPathPattern任何一个url则默认拦截所有请求。

添加excludePathPatterns可以放过对应地址的请求。

总的来说，注册拦截器时设置对应地址的拦截，只要是对路由下地址的请求都会进入拦截器。如不设置对应地址的拦截，所有请求都会进入拦截器。当然可以添加excludePathPatterns可以放过对部分地址的请求。

4 REST风格

4.1 REST风格介绍

REST即表述性状态传递（英文：Representational State Transfer，简称REST）。REST中，所有资源以一种状态（表现形式）保存在服务器端中。因此，如果客户端想要操作服务器，需要通过某种手段，如HTTP操作，将服务器中的资源状态在表现层上进行转换，这就是"表述性状态转化"。

如果一个互联网软件服务架构符合REST风格，则称为Restful，所以Restful指的是一种设计风格，而不是一种技术。客户端和服务端交互中基于这种风格原则设计出的Web api更加简洁，更有层次。

在Web api开发中，客户端使用GET获取资源，POST新建资源，PUT更新资源，DELETE删除资源，通过这些操作转换资源的表现形式来实现服务端请求操作。

SpringBoot提供的spring-boot-starter-web组件完全支持开发RESTful api，提供了与REST操作方式对应的注解：

@GetMapping：处理GET请求，获取数据。

@PostMapping：处理POST请求，新增数据。

@PutMapping：处理PUT请求，更新资源。

@DeleteMapping：处理DELETE请求，删除资源。

@PatchMapping：处理PATCH请求，用于部分更新资源。

符合RESTful规范的Web api需要具备如下两个关键特性：

安全性：安全的请求操作期望不会产生任何副作用，也就是如通过GET操作获取资源时不会改变资源本身，也不会引起服务器状态的改变。

幂等性：在数学上幂等性是指N次变换和一次变换相同，幂等的方法保证了进行一个请求和重复一次请求的效果相同。

总之简单地说，一个HTTP请求除了利用url标志目标资源以外，还需要通过HTTP Method指定针对该资源表现形式转换的操作类型。

在RESTful架构中，利用URL标志目标资源，所以说最常见的一种设计错误，就是URI包含动词。因为"资源"表示一种实体，所以应该是名词，URI不应该有动词，动词应该放在HTTP协议中。

示例：

HTTP METHODS	接口地址	接口说明
POST	/user	创建用户
GET	/user/id	根据id获取查询某一用户
PUT	/user	更新用户
DELETE	/user/id	根据id删除某一用户

4.2 SpringBoot实现RESTful API

@RestController
public class RestfulApi {
    @Autowired
    UserMapper userMapper;

    @GetMapping("/user/{id}")
    public String getUserById(@PathVariable int id){
        User user = userMapper.selectById(id);
        return "根据id获取用户："+user;
    }

    @PostMapping("/user")
    public String addUser(User user) {
        int insert = userMapper.insert(user);
        return "添加用户"+user;
    }

    @PutMapping("/user")
    public String updateUser(User user) {
        userMapper.update(user,null);
        return "更新用户"+user;
    }

    @DeleteMapping("/user/{id}")
    public String deleteUser(@PathVariable int id){
        int i = userMapper.deleteById(id);
        return "根据id删除用户";
    }
}

数据库初始表：

a.发送根据id查询获取用户的请求：

b.发送创建用户的请求：

c.发送未指定id进行密码更新的请求，会将所有用户的密码进行更新：

d.发送根据id删除用户的请求：

5 Swagger生成WebAPI文档

Swagge是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务，是非常流行的API表达工具。同时Swagger还能够自动生成完善的RESTful API文档页面，并根据后台代码的修改同步更新。

在SpringBoot项目中集成Swagger非常简单，只需在项目中引入springfox-swagger2和springfox-swagger-ui两个依赖即可：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

通过配置类配置Swagger：

@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.bree"))
                .paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("Swagger2")
                .description("学习Swagger2")
                .build();
    }
}

注意事项：SpringBoot2.6.x以后的版本与Swagger有版本冲突问题，需要在application.properties中加入以下配置：

spring.mvc.pathmatch.match-strategy=ant_path_matcher

启动项目访问http://localhost:xxxx/swagger-ui.html，即可打开自动生成的可视化测试文档页面。

Swagger提供了一系列注解来描述接口信息，包括接口说明、请求方法、请求参数、返回信息等。如可以在接口方法上添加@ApiOperation描述接口的功能：（其他的注解可以参考文档）

Maxlec

关注

2
点赞
踩
7

收藏

觉得还不错? 一键收藏
打赏
0
评论
第一篇：SpringBoot项目的创建和开发

SpringBoot是由Pivotal团队提供的基于Spring的全新框架，旨在简化Spring应用的初始搭建和开发过程。Java开发企业级应用一般会涉及到三个框架，Spring、SpringMVC和Mybatis，也就是SSM，其开发特点是配置特别繁琐，涉及大量的xml文件。SpringBoot的设计目标就是使开发者能够更轻松地创建独立的、基于Spring的应用程序，而无需过多的配置。尽可能地简化应用开发的门槛，让应用开发、测试、部署变得更加简单。
复制链接

扫一扫