ramostear.comramostear.com 谭朝红的技术分享博客

格言 编程是一门技术,也是一门艺术 !

如何在Spring Boot中解决跨域问题?

如何在Spring Boot中解决跨域问题?

Spring Boot(十三)— CORS跨域支持

CORS,全称Cross-Origin Resource Sharing,是一种允许当前域(domain)的资源(比如html/js/web service)被其他域(domain)的脚本请求访问的机制,通常由于同域安全策略(the same-origin security policy)浏览器会禁止这种跨域请求。它会在你进行如下的请求时被触发:

在本章节的内容中,我将以一个简单的案例来讲解在Spring Boot中如何处理跨域请求资源。

1. 局部跨域

在Spring Boot应用程序中,你可以使用@CrossOrign注解来开启单个控制器支持跨域请求操作。需要注意@CrossOrign的作用范围只在被注释的Rest API(局部支持跨域)。下面的代码给出了一个简单的演示:

@GetMapping("/users")
@CrossOrign(origins="http://localhost:8080")
public ResponseEntity<Object> users(){
    return null;
}

2. 全局跨域

Spring Boot提供了显示Bean装配的方式配置允许全局跨域操作。你可以参照下面给出的代码配置允许全局跨域请求:

@Bean
    public WebMvcConfigurationSupport crossConfig(){
        return new WebMvcConfigurationSupport(){
            @Override
            public void addCorsMappings(CorsRegistry registry){
                registry.addMapping("/users").allowedOrigins("http://localhost:8080");
            }
        };
    }

3. 跨域调用

现在,创建一个控制调用第六章—RESTful Web服务,获取用户的信息。在这里,我们使用RestTemplate调用User Restful Web服务,如何使用RestTemplate,请阅读第十章 — RestTemplate相关内容。下面的代码显示了使用RestTemplate进行跨域调用Restful Web服务。

package com.ramostear.application.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.*;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

import java.util.Arrays;

/**
 * @author ramostear
 * @create-time 2019/3/11 0011-7:14
 * @modify by :
 * @since:
 */
@RestController
public class UserController {
    private static final String ROOT_URI = "http://localhost:8080/users";

    @Autowired
    RestTemplate restTemplate;

    @GetMapping("/users")
    public String getUsers(){
        HttpHeaders headers = new HttpHeaders();
        headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
        HttpEntity<String> entity = new HttpEntity<>(headers);
        return restTemplate.exchange(ROOT_URI, HttpMethod.GET,entity,String.class).getBody();
    }

}

除此之外,需要修改application.propertiesserver.port属性的值为8090(或者其他与User Restful Web服务不冲突的端口号):

server.port= 8090

现在,分别启动两个应用程序,并测试跨域调用是否成功。启动Postman测试应用程序,在地址栏输入:http://localhost:8090/users, 发送请求,并观察页面变化:

在Spring Boot中定义服务组件

在Spring Boot中定义服务组件

Spring Boot(十二)— 服务组件

所谓的服务组件(Service Component)— 就是用于处理系统业务逻辑的类,如果按照系统分层设计理论来划分,服务组件是位于业务层当中的类。在Spring Boot中,服务组件是一个被@Service注解进行注释的类,这些类用于编写系统的业务代码。在本章节中,将讲解如何创建并使用服务组件。

在开始正文之前,先来看两段示例代码。使用服务组件之前,我们需要定义服务组件接口类,用于索引服务组件提供的服务,代码如下所示:

public interface UserService{
    // TODO ...
}

然后,需要使用@Service注解对服务组件接口实现类进行注释,演示代码如下:

@Service(value="userService")
public class UserServiceImpl implements UserService{
    //TODO ...
}

最后,使用@Autowired注解来自动引用服务组件,代码如下:

@Controller
public class DemoController{
    @Autowired
    UserService userService;
    //TODO ...
}

在本次讲解中,我们依然以对用户的增、删、改、查为案例,将控制器中的业务方法迁移到服务组件中。

1. 创建服务接口

创建一个包含添加用户、更新用户、删除用户和查询用户的服务接口类 — 用户服务组件接口类。详细代码如下:

package com.ramostear.application.service;

import com.ramostear.application.model.User;

import java.util.Collection;

/**
 * Created by ramostear on 2019/3/11 0011.
 */
public interface UserService {

    /**
     * create user
     * @param user
     */
    void create(User user);

    /**
     * update user info by ID
     * @param id
     * @param user
     */
    void update(long id,User user);

    /**
     * delete user by ID
     * @param id
     */
    void delete(long id);

    /**
     * query all user
     * @return
     */
    Collection<User> findAll();
}

2. 实现服务接口

创建一个接口实现类,用于实现其中的增、删、改、查四个业务方法,并用@Service注解进行标注,具体代码如下:

package com.ramostear.application.service.impl;

import com.ramostear.application.model.User;
import com.ramostear.application.service.UserService;
import org.springframework.stereotype.Service;

import javax.annotation.PostConstruct;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

/**
 * @author ramostear
 * @create-time 2019/3/11 0011-4:29
 * @modify by :
 * @since:
 */
@Service(value="userService")
public class UserServiceImpl implements UserService {

    private static Map<Long,User> userRepo = new HashMap<>();

    @PostConstruct
    public void initUserRepo(){
        User admin = new User();
        admin.setId(1).setName("admin");
        userRepo.put(admin.getId(),admin);

        User editor = new User();
        editor.setId(2).setName("editor");
        userRepo.put(editor.getId(),editor);
    }
    @Override
    public void create(User user) {
        userRepo.put(user.getId(),user);
    }

    @Override
    public void update(long id, User user) {
        userRepo.remove(id);
        user.setId(id);
        userRepo.put(id,user);
    }

    @Override
    public void delete(long id) {
        userRepo.remove(id);
    }

    @Override
    public Collection<User> findAll() {
        return userRepo.values();
    }
}

3. 使用服务组件

接下来,定义一个用户控制器,使用@Autowired注解来应用用户服务组件,实现对用户的增、删、改、查功能:

package com.ramostear.application.controller;

import com.ramostear.application.model.User;
import com.ramostear.application.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

/**
 * @author ramostear
 * @create-time 2019/3/11 0011-4:42
 * @modify by :
 * @since:
 */
@RestController
public class UserController {

    @Autowired
    UserService userService;


    @GetMapping("/users")
    public ResponseEntity<Object> users(){
        return new ResponseEntity<>(userService.findAll(), HttpStatus.OK);
    }

    @PostMapping("/users")
    public ResponseEntity<Object> create(@RequestBody User user){
       userService.create(user);
       return new ResponseEntity<>("User is created successfully.",HttpStatus.CREATED);
    }

    @PutMapping("/users/{id}")
    public ResponseEntity<Object> update(@PathVariable(name="id") long id,@RequestBody User user){
        userService.update(id,user);
        return new ResponseEntity<>("User is updated successfully.",HttpStatus.OK);
    }

    @DeleteMapping("/users/{id}")
    public ResponseEntity<Object> delete(@PathVariable(name = "id")long id){
        userService.delete(id);
        return new ResponseEntity<>("User is deleted successfully.",HttpStatus.OK);
    }
}

4. 数据模型

用户对象的代码沿用以往章节的User.java代码:

package com.ramostear.application.model;

import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/**
 * @author ramostear
 * @create-time 2019/3/6 0006-3:12
 * @modify by :
 * @since:
 */
@Getter
@Setter
@NoArgsConstructor
public class User {
    private long id;
    private String name;

    public User setId(long id){
        this.id = id;
        return this;
    }

    public User setName(String name){
        this.name = name;
        return this;
    }
}

注:应用程序主类和Maven build文件与之前章节的代码形同,不再列举。

5. 运行测试

启动Spring Boot应用程序,然后打开Postman测试应用程序,分别进行如下的测试。

GET 请求:获取所有的用户信息。

URL地址:http://localhost:8080/users

获取用户信息

POST 请求:新增一位用户信息

URL地址:http://localhost:8080/users

请求参数:{“id”:3,”name”:”reader”}

新增用户

PUT请求:修改用户信息

URL地址:http://localhost:8080/users/3

请求参数:{“id”:3,”name”:”ramostear”}

修改用户

DELETE请求:删除用户信息

URL地址:http://localhost:8080/users/3

删除用户

6. 附件

本章节用于演示的项目源码已经上传到Github代码仓库,你可以通过下面的地址链接免费获取本章节的全部源码信息:https://github.com/ramostear/Spring-Boot-Service-Component

Spring Boot 2.0 概述

Spring Boot 2.0 概述

Spring Boot 2.0 概述

Spring Boot 是由Pivotal团队基于Java开发的一个开源框架,可用于构建独立的、可部署的生产环境下的Spring应用。

1 . 什么是微服务?

在介绍Spring Boot之前,我们先聊一聊微服务的概念。Micro Service是一种允许开发人员独立开发和部署服务的一种体系架构。每个服务实例都独立部署和运行,它们具有自身的操作流程。简单来说,微服务就是将传统的庞大的业务应用程序按照某种业务规则(轻量级模型)进行拆分,拆分后,每个服务都有自己的服务上线文边界,以达到服务区域内的自治,同时又可以通过消息总线与其他服务模块进行通信,协同完成某一个业务操作流程。

1.2. 微服务的好处

微服务为开发人员带来了以下的一些优势:

  • 易于部署
  • 简单的可扩展性
  • 与容器兼容
  • 最低限度的硬件配置
  • 开发时间短

2. 什么是Spring Boot?

Spring Boot 为Java开发人员提供了一个优秀的统一平台,开发人员可以利用Spring Boot 开发出一个生产级别的可独立运行的Spring应用程序。通过Spring Boot,开发人员可以使用最少的配置,完成复杂的Spring应用程序设置。

2.1. Spring Boot 的优势

使用Spring Boot进行开发,将具备如下的一些优势:

  • 使得Spring应用程序易于理解和开发
  • 提高开发效率
  • 缩短了软件交付的时间

2.2. Spring Boot 的设计目标

Spring Boot的出现,其追求的目标如下:

  • 弱化使用XML配置文件的方式对Spring应用程序进行设置
  • 以更简单易懂的方式开发生产级别的Spring应用程序
  • 以更短的时间交付可独立运行的Spring应用程序
  • 降低Spring 框架的学习门槛

3. 为什么选择Spring Boot?

要不要选择一门技术入手,需要分析它的用户群体数量、性能指标、普适性和学习成本。就Spring Boot本身而言,其自身具备如下的几个优点:

  • 提供了一种更为优雅和易懂的方式来配置Java Bean、XML和数据库事务
  • 提供了强大的批处理和REST Endpoint管理能力
  • 提供了强大的自动装配能力,减少人工干预的次数
  • 采用注解的方式开发应用程序
  • 极大的简化了依赖管理工作
  • 提供了嵌入式的Servlet容器,如Tomcat 、Jetty等

4. Spring Boot的工作方式

Spring Boot 通过 @EnableAutoConfiguration 注解将存在于项目类路径上的依赖项自动装配到应用程序中,无需其他的人工干预。使用@SpringBootApplication 注解标注一个包含main方法的类,此类就成为Spring Boot应用程序的主入口。@ComponentScan 注解将会触发Spring Boot自动扫描项目中包含的所有组件。

5 . Spring Boot Starter

对于一个大型的项目而言、最让开发人员头疼的事情是如何管理整个项目中的依赖关系和与之对应的版本问题。Spring Boot提供了一组特定的依赖项来帮助开发人员解决此问题。例如,如果要在Spring Boot项目中使用JPA来访问数据库,则只需要在项目中引入spring-boot-starter-data-jpa 依赖项即可。

几乎所有的Spring Boot Starter都遵循相同的命名模式:“spring-boot-starter-*” ,其中的“*”表示一种应用程序的类型名称

下面我们列举几个常用的Spring Boot Starter加以说明:

  • spring-boot-starter-web : 用于依赖Spring web
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
  • spring-boot-starter-thymeleaf : 用于依赖Thymeleaf模板引擎

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-thymeleaf</artifactId>
    </dependency>
    
  • spring-boot-starter-test : 用于依赖单元测试

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
    </dependency>
    

6 . 自动装配

Spring Boot Auto Configuration会自动将添加到项目中的依赖JAR包完成相应的配置。例如,如果你在pom.xml中引入了MySQL的依赖包,在不添加任何配置的情况下,Spring Boot会自动配置内置数据库。如果需要开启自动装配功能,需要在项目主类上添加@EnableAutoConfiguration注解或者@SpringBootApplication注解:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;

@EnableAutoConfiguration
public class Application{
    public static void main(String[] args){
        SpringApplication.run(Application.class);
    }
}

7. Spring Boot 主应用程序

一个Spring Boot的主应用程序需包含两个部分:

  • @SpringBootApplication 注解:用于标注一个类为Spring Boot应用的启动类
  • main 方法:Spring Boot应用程序的主入口

@SpringBootApplication是一个组合注解,它包含了自动装配、组件扫描和Spring Boot配置。我们也可以单独使用@EnableAutoConfiguration@ComponentScan@SpringBootConfiguration 注解来标注主类。

使用@SpringBootApplication进行标注:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Application{
    public static void main(Stirng[] args){
        SpringApplication.run(Application.class);
    }   
}

使用@EnableAutoConfiguration@ComponentScan@SpringBootConfiguration 进行标注:

@EnableAutoConfiguration
@ComponentScan
@SpringBootConfiguration
public class Application{
    public static void main(String[] args){
        SpringApplication.run(Application.class);
    }
}

8. 组件扫描

Spring Boot应用程序在程序初始化阶段完成组件扫描的工作。使用@ComponentScan对主类进行标注,将开组件扫描功能:

@ComponentScan
public class Application{
    public static void main(String[] args){
        SpringApplication.run(Application.class);
    }
}
如何在Tomcat中部署Spring Boot程序?

如何在Tomcat中部署Spring Boot程序?

Spring Boot(三)—Tomcat中部署

Spring Boot应用程序除了生成JAR文件直接运行外,也可以创建成一个WAR文件部署到Web服务器中。在本章节中,我将为你展示如何使用Spring Boot创建WAR文件并在Tomcat Web容器中进行部署。

1. Spring Boot Servlet初始化程序

如果想要在Tomcat Web服务器中部署Spring Boot应用程序,需要让被@SpringBootApplication注解注释的的主类继承SpringBootServletInitializer类,并覆盖configure方法。

下面的代码片段是使用JAR文件运行Spring Boot应用程序的主文件代码:

package com.ramostear.spring.boot.deploytomcat;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author ramostear
 */
@SpringBootApplication
public class DeployTomcatApplication {

    public static void main(String[] args) {
        SpringApplication.run(DeployTomcatApplication.class, args);
    }

}

现在,我们需要扩展SpringBootServletInlitializer类以支持WAR文件部署。扩展后的主类代码如下:

package com.ramostear.spring.boot.tutorial2;

@SpringBootApplication
public class Application extends SpringBootServletInitializer{
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder){
        return builder.sources(Application.class,args);
    }
    public static void main(String[]args){
        SpringBootApplication.run(Application.class,args);
    }
}

2. 设置主类

对于Spring Boot应用程序,你需要明确的指出在maven构建项目是主类的位置。你需要在pom.xml文件加入如下的代码:

<start-class>com.ramostear.spring.boot.tutorial2.Application</start-class>

3. 更新打包方式

想要将Spring Boot应用程序从jar包更换为war包,还需要修改pom.xml中的packaging配置:

<packaging>war</packaging>

现在,我们可以编写一个简单的REST Endpoint来返回字符串“Hey Spring Boot,I am from tomcat server.”。为了演示此功能,我们还需要将Spring Boot Web Starter添加到pom.xml文件中:

<dependencies>
    ...
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    ...
</dependencies>

接下来,我们将在主类中编写一个简单的REST Endpoint:

package com.ramostear.spring.boot.deploytomcat;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author ramostear
 */
@SpringBootApplication
@RestController
public class DeployTomcatApplication extends SpringBootServletInitializer {

    public static void main(String[] args) {
        SpringApplication.run(DeployTomcatApplication.class, args);
    }

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        return builder.sources(DeployTomcatApplication.class);
    }

    @GetMapping("/")
    public String sayHello(){
        return "Hey Spring Boot,I am from tomcat server.";
    }
}

4. 打包Spring Boot应用程序

我们将使用Maven打包命令创建一个可以在Tomcat服务器中运行的WAR文件。使用Maven命令:mvn:package打包应用程序。你可以在当前工程下的target目录中找到war文件:

C:\~projectdir> mvn package

控制台输出:

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building deploy-tomcat 0.0.1-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- maven-resources-plugin:3.1.0:resources (default-resources) @ deploy-tomcat ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 1 resource
[INFO] Copying 0 resource

.....


[INFO] 
[INFO] --- spring-boot-maven-plugin:2.1.3.RELEASE:repackage (repackage) @ deploy-tomcat ---
[INFO] Replacing main artifact with repackaged archive
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 10.273 s
[INFO] Finished at: 2019-03-04T23:34:12+08:00
[INFO] Final Memory: 38M/288M
[INFO] ------------------------------------------------------------------------

Process finished with exit code 0

5 . 部署到Tomcat

现在,运行Tomcat服务器,并在webapps目录下部署准备好的war文件。你也可以登录Tomcat的管理界面上传war文件并部署:

成功部署war文件后,代开浏览器,并在浏览器地址栏输入:http://localhost:8080/deploy-tomcat-0.0.1-SNAPSHOT/ ,观察页面输出结果:

6 . 主要代码

pom.xml代码:

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.ramostear</groupId>
    <artifactId>deploy-tomcat</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>deploy-tomcat</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </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>
    <packaging>war</packaging>
</project>

DeployTomcatApplication.java文件:

package com.ramostear.spring.boot.deploytomcat;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author ramostear
 */
@SpringBootApplication
@RestController
public class DeployTomcatApplication extends SpringBootServletInitializer {

    public static void main(String[] args) {
        SpringApplication.run(DeployTomcatApplication.class, args);
    }

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        return builder.sources(DeployTomcatApplication.class);
    }

    @GetMapping("/")
    public String sayHello(){
        return "Hey Spring Boot,I am from tomcat server.";
    }
}
Spring Boot 2.0 快速构建应用

Spring Boot 2.0 快速构建应用

Spring Boot系列教程(二)快速构建

在本章节中,将想你展示如何利用Spring Initializer快速构建一个Spring Boot应用程序。

1. Spring Initializer

快速构建起一个Spring Boot应用程序的方法之一是使用Spring Initializer.首先,我们需要访问Spring Initializer的官网https://start.spring.io ,接下来,我们需要选择相应的构建方式、语言以及Spring Boot的版本。默认的构建方式是Maven Project,使用Java语言,Spring Boot的版本默认最新版本。

接下来,我们需要提供一个项目的GroupId和ArtifactId,最后是检索并选择我们需要引入的依赖包。以上选择设置完成后,点击“Generate Project”按钮生成并下载Spring Initializer生成的项目包。本次案例中,我们将添加spring-boot-starter-web依赖项,用于编写一个REST风格的端点示例:

Spring Initializer

2.Maven

现在,解压下载后的项目压缩包,并导入到对应的IDE中(本次案例使用的是Spring Tools Suite),打开根目录下的pom.xml文件:

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.ramostear</groupId>
    <artifactId>quick-build</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>quick-build</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </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>

3. 依赖包

Spring Boot为开发者提供了很多starters用于快速添加依赖包。本次案例中我们添加了一个Spring Web依赖的Starter:

...
<dependencies>
    ...
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    ...
</dependencies>
...

4. 主类和方法

一个Spring Boot应用程序需要提供应用主类和方法,并且该主类需要(通常)使用@SpringBootApplication注解进行标注。你可以在src/java/main目录下找到主类文件。

此示例中,主类文件位于src/java/main目录中,且位于com.ramostear.quickbuild包中:

package com.ramostear.quickbuild;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
 * @author:  ramostear
 * @date:   2019年3月3日下午9:49:28
 */
@SpringBootApplication
public class QuickBuildApplication {

    public static void main(String[] args) {
        SpringApplication.run(QuickBuildApplication.class, args);
    }

}

5. REST EndPoint

接下来,我们将在主类中编写一个返回“Hello Spring Boot”信息的Rest Endpoint。我们需要在主类上新增一个@ResController注解,然后使用@GetMapping注解注释我们的请求方法:

package com.ramostear.quickbuild;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @author:  ramostear
 * @date:   2019年3月3日下午9:49:28
 */
@SpringBootApplication
@RestController
public class QuickBuildApplication {

    public static void main(String[] args) {
        SpringApplication.run(QuickBuildApplication.class, args);
    }


    @GetMapping("/")
    public String sayHello() {
        return "Hello Spring Boot.";
    }


}

6. 创建可执行的JAR文件

现在,我们可用通过Maven命令行来创建一个可执行的JAR文件。在命令行工具中使用Maven命令:mvn clean install

mvn clean install

执行上述命令后,你可以在控制台看到BUILD SUCCESS消息:

BUILD SUCCESS

7. 运行JAR 文件

上述步骤完成后,可以在target目录中找到创建的JAR文件:

target dir

现在,可以使用命令java -jar 运行JAR文件。本案例中创建的JAR文件名为quick-build-0.0.1-SNAPSHOT.jar

C:\Users\Administrator\Desktop\quick-build\target> java -jar quick-build-0.0.1-SNAPSHOT.jar

JAR文件成功运行后,你可以在控制台下看到如下的信息输出:

console start infomatioin

控制台信息显示Tomcat容器的服务端口为8080,打开浏览器并在地址栏输入http://localhost:8080/,你可以看到如下的输出:

browser info

配置Spring Boot 应用程序参数

配置Spring Boot 应用程序参数

Spring Boot(四)—应用程序属性

Spring Boot应用程序属性支持我们开发的应用工作在不同的环境中。在本章节中,我将展示如何配置和指定Spring Boot 应用程序的属性。

1. 命令行属性

Spring Boot应用程序可以将命令行属性转换为Spring Boot Environment属性。在Spring Boot中,命令行属性的优先级高于其他资源属性。在默认情况下,Spring Boot使用8080端口作为Tomcat的启动端口。下面让我们使用命令行属性来更改端口号:

  • 1.创建可执行的JAR文件,然后使用命令 java -jar 运行jar文件。

  • 2.使用命令行更改Spring Boot应用程序的默认端口号

    D:\work\2019\domain-driver-design\deploy-tomcat\target> java -jar deploy-tomcat-0.0.1-SNAPSHOT.war --server.port = 8888
    

    :你可以使用分隔符“-”来分割多个属性

2. 属性文件

属性文件的作用是可以在单个文件中设置多个属性的值。在Spring Boot 应用程序中,属性保存在类路径下的application.properties文件中。通常情况下,application.properties文件存放在src/main/resource目录中,其属性设置格式如下:

server.port = 8888
server.tomcate.max-http-post-size = -1
spring.application.name = spring-boot-tutorial
spring.datasource.username = admin
spring.datasource.password = springboottutorial
...

3 . YAML文件

Spring Boot应用程序支持基于YAML格式的属性配置文件为Spring Boot提供属性设置。YAML文件时Spring Boot比较推荐的属性配置文件,相较于application.properties文件,YAML配置文件册层次更为清晰。同样的,YAML文件也存放于类路径下(“src/main/resource”),其文件内容格式为:

server:
  port: 8888
  tomcate:
    max-http-post-size: -1
spring: 
  application:
    name: spring-boot-tutorial
  datasource:
    username: admin
    password: springboottutorial
  mvc:
    favicon:
      enabled: false

注:YAML文件中,每个属性的上下层级之间相差两个空格

4. 外部属性文件

Spring Boot支持我们将属性配置文件放在外部空间中,而不仅仅局限于将配置文件放置在类路径下。在运行JAR文件的时候,我们可以指定外部配置文件的存放路径。

D:\work\2019\domain-driver-design\deploy-tomcat\target> java -jar -Dspring.config.location = D:\work\configs\application.properties deploy-tomcat-0.0.1-SNAPSHOT.war

5. @Value 注解

在Spring Boot应用程序中,可以使用@Value注解读取应用中的属性值,其读取相关属性值得语法如下:

@Value("${property_key_name}")
Object param;

接下来,我们将演示使用@Value注解来读取application.properties配置文件中spring.application.name属性的值:

@Value("${spring.application.name}")
private String appName;

完整的示例代码:

package com.ramostear.spring.boot.properties;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class SpringBootPropertiesApplication {

    @Value("${spring.application.name}")
    private String appName;

    public static void main(String[] args) {
        SpringApplication.run(SpringBootPropertiesApplication.class, args);
    }

    @GetMapping("/")
    public String say(){
        return appName;
    }
}

application.properties文件内容:

spring.application.name= Spring Boot Properties Demo

下面,我们启动程序,并在浏览器地址栏中输入:http://localhost:8080/ ,观察浏览器页面结果:

注:如果在程序运行时没有在配置文件中提供该属性,则Spring Boot将抛出IllegalArgumentException异常信息:

Could not resolve placeholder 'spring.application.name' in value "${spring.application.name}"

因为Spring Boot无法解析表达式“${spring.application.name}”中的占位符“spring.application.name”。

要解决上面演示的问题,只需要在表达式后面增加一个默认的属性值即可。

  • 语法:

    @Value("${property_key_name:default_value}")
    
  • 代码示例:

    package com.ramostear.spring.boot.properties;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @SpringBootApplication
    @RestController
    public class SpringBootPropertiesApplication {
    
        @Value("${spring.application.name:Spring Boot Application}")
        private String appName;
    
        public static void main(String[] args) {
            SpringApplication.run(SpringBootPropertiesApplication.class, args);
        }
    
        @GetMapping("/")
        public String say(){
            return appName;
        }
    }
    

再次运行应用程序,观察浏览器页面变化:

6. active配置模式

Spring Boot支持基于Spring active模式来设置不同环境下的应用属性。例如,我们可以创建两份配置文件application_dev.properties和application_prod.properties,application_dev.properties用于开发环境中设置属性,application_prod.properties则用于生产环境中配置应用属性。

首先,我们来看一下默认的application.properties文件中的配置:

server.port = 8888
spring.application.name = Default Spring Boot Application Name

启动应用程序,观察控制台输出信息:

2019-03-05 01:29:19.590  INFO 7828 --- [main] .r.s.b.p.SpringBootPropertiesApplication : 
No active profile set, falling back to default profiles: default

2019-03-05 01:29:20.869  INFO 7828 --- [main] o.s.b.w.embedded.tomcat.TomcatWebServer  : 
Tomcat initialized with port(s): 8888 (http)

现在,Tomcat服务器已经使用8888端口启动成功,且提示没有设置任何的active profile。

接下来,我们创建两个active配置文件application_dev.properties和application_prod.properties,其配置内容如下。

application_dev.properties配置文件:

server.port = 8081
spring.application.name = Development Spring Boot Application Name

application_prod.properties配置文件:

server.port = 8082
spring.application.name = Product Spring Boot Application Name

两个独立的配置文件准备好后,我们需要调整application.properties文件的配置内容,以模拟使用active配置文件来切换不同环境下使用不同的属性配置:

  • 1.将默认的属性配置切换到dev模式上,切换到开发环境上的配置命令如下:

    D:\work\2019\domain-driver-design\spring-boot-properties\target> java -jar spring-boot-properties-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev
    

    你可以在控制台中观察到如下的输出:

    2019-03-05 02:02:00.013  INFO 7700 ---[main] .r.s.b.p.SpringBootPropertiesApplication : The following profiles are active: dev
    2019-03-05 02:02:01.697  INFO 7700 --- [main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8081 (http)
    2019-03-05 02:02:01.732  INFO 7700 --- [main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
    

    现在,Tomcat服务器已经使用端口8081(http)

  • 2.接下来,我们再将应用从dev切换到prod环境上,执行如下命令:

    D:\work\2019\domain-driver-design\spring-boot-properties\target>java -jar spring-boot-properties-0.0.1-SNAPSHOT.jar --spring.profiles.active=prod
    

    你可以在控制台中观察到如下的输出:

    2019-03-05 02:09:33.983  INFO 5944 --- [main] .r.s.b.p.SpringBootPropertiesApplication : The following profiles are active: prod
    
    2019-03-05 02:09:35.643  INFO 5944 --- [main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8082 (http)
    
    2019-03-05 02:09:35.678  INFO 5944 --- [main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
    

    现在,Tomcat服务器已经使用端口8082(http)

如果应用使用的是YAML文件来配置应用属性,我们可以将不同环境的配置信息放在一个配置文件中,而不用像使用properties文件那样创建多个独立的配置文件。

下面我们将演示使用YAML文件来配置并切换不同环境下的属性配置,在YAML文件中,使用分隔符“—-”来分割不同active下的属性配置:

application.yml配置文件

spring:
   application:
      name: Default Spring Application Name
server:
   port: 8080

---
spring:
   profiles: dev
   application:
      name: Development Spring Application Name
server:
   port: 8081

---
spring:
   profiles: prod
   application:
      name: Product Spring Application Name
server:
   port: 8082

说明:使用YAML作为配置文件时,切换active的命令与使用Properties配置文件时一致。

优雅的处理Spring Boot异常信息

优雅的处理Spring Boot异常信息

Spring Boot (七)— 异常处理

异常处理是一种识别并响应错误的一致性机制,异常机制可以把程序中的异常处理代码和正常的业务逻辑代码分离,包装程序的可读性和健壮性。在Spring Boot应用程序中,能够捕获并及时的响应客户端的错误操作是一件非常重要的事情。在本章节中,我将展示如何处理Spring Boot中的异常。

1. 相关注解说明

在进行演示之前,我们先了解一下在Spring Boot应用程序中与异常处理相关的几个注解

注解名称 说明
@ControllerAdvice 该标签用于处理全局的异常信息
@ExceptionHadler 用于处理特定异常信息,并返回相关的响应到客户端

首先,我们需要使用@ControllerAdvice注解来定义一个全局的异常信息处理类,其语法如下:

package com.ramostear.exception.handler;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

/**
 * @author : ramostear
 * @date : 2019/3/6 0006-16:33
 */
@ControllerAdvice
public class UserExceptionHandler {
    //TODO ...
}

接下来,我们需要定义一个扩展了RuntimeException类的自定义异常处理类:

package com.ramostear.exception.handler;

/**
 * @author : ramostear
 * @date : 2019/3/6 0006-16:31
 */
public class UserNotFoundException extends RuntimeException{
    private static final long serialVersionUID = 5534028121297403043L;
}

最后,我们使用@ExceptionHandler注解来定义一个处理具体异常信息的方法,其语法如下:

@ExceptionHandler(value = UserNotFoundException.class)
    public ResponseEntity<Object> exception(UserNotFoundException ex){
        return new ResponseEntity<>("user not found.", HttpStatus.NOT_FOUND);
    }

以上工作准备完成之后,我们可以使用如下的方式来处理API中的异常信息:

@GetMapping("/users/{id}")
    public ResponseEntity<Object> getUser(@PathVariable(name = "id") long id){
        if(!userRepo.containsKey ( id )){
            throw new UserNotFoundException ();
        }
        return new ResponseEntity<> (userRepo.get (id), HttpStatus.OK);
    }

在接下来的内容当中,我将给出完整的示例代码,使用HTTP GET方法请求一个用户信息,当用户存储库中没有相应的用户信息时,返回“user not found”提示信息。

2. 自定义异常信息类 — UserNotFoundException.java

package com.ramostear.exception.handler;

/**
 * @author : ramostear
 * @date : 2019/3/6 0006-16:31
 */
public class UserNotFoundException extends RuntimeException{
    private static final long serialVersionUID = 5534028121297403043L;
}

说明:这里只是做了一个简单的扩展

2. 全局异常处理类 —UserExceptionHandler.java

package com.ramostear.exception.handler;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

/**
 * @author : ramostear
 * @date : 2019/3/6 0006-16:33
 */
@ControllerAdvice
public class UserExceptionHandler {


    @ExceptionHandler(value = UserNotFoundException.class)
    public ResponseEntity<Object> exception(UserNotFoundException ex){
        return new ResponseEntity<>("user not found.", HttpStatus.NOT_FOUND);
    }


}

在UserExceptionHandler.java文件中,我们定义了一个处理用户不存在异常的方法,

3. API类 — UserServiceController.java

package com.ramostear.exception.handler.controller;

import com.ramostear.exception.handler.UserNotFoundException;
import com.ramostear.exception.handler.model.User;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.PostConstruct;
import java.util.HashMap;
import java.util.Map;

/**
 * @author : ramostear
 * @date : 2019/3/6 0006-16:26
 */
@RestController
public class UserServiceController {

    private static Map<Long,User> userRepo = new HashMap<>();

    @PostConstruct
    public void initUserRepo(){
        User admin = new User ().setId ( 1 ).setName ( "admin" );
        userRepo.put ( admin.getId (),admin );

        User editor = new User ().setId ( 2 ).setName ( "editor" );
        userRepo.put ( editor.getId (),editor );
    }


    @GetMapping("/users/{id}")
    public ResponseEntity<Object> getUser(@PathVariable(name = "id") long id){
        if(!userRepo.containsKey ( id )){
            throw new UserNotFoundException ();
        }
        return new ResponseEntity<> (userRepo.get (id), HttpStatus.OK);
    }

}

在getUser()方法中,如果用户没有找到,则抛出UserNotFoundException异常。

4. 应用主类 —ExceptionHandlerApplication.java

package com.ramostear.exception.handler;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ExceptionHandlerApplication {

    public static void main(String[] args) {
        SpringApplication.run(ExceptionHandlerApplication.class, args);
    }

}

5. 用户POJO类 — User.java

package com.ramostear.exception.handler.model;

import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/**
 * @author : ramostear
 * @date : 2019/3/6 0006-16:23
 */
@Getter
@Setter
@NoArgsConstructor
public class User {

    private long id;

    private String name;

    public User setId(long id){
        this.id = id;
        return this;
    }

    public User setName(String name){
        this.name = name;
        return this;
    }
}

6. Maven构建文件 — pom.xml

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.ramostear</groupId>
    <artifactId>exception-handler</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>exception-handler</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

8. 运行测试

接下来,我们将打包运行我们的程序,本次教程演示将使用IDEA来运行程序,运行结果如下图所示:

然后,启动Postman应用程序,我们先在地址栏输入:http://localhost:8080/users/1 ,观察正常情况下的测试信息:

Postman的测试结果显示,请求状态为200,且返回了用户的详细信息。现在,我们更新URL为:http://localhost:8080/users/3 ,再次观察测试结果:

此时的HTTP Status为404,且返回了“user not found.”的提示信息。

使用Spring Boot构建RESTful 服务

使用Spring Boot构建RESTful 服务

Spring Boot(六) — 构建RESTful Web服务

Spring Boot能够轻松的构建起企业级的RESTful Web服务程序。在本章节中,我将通过一个简单的例子演示Spring Boot的这一能力。
为了构建RESTful Web服务,我们需要将Spring Boot Starter Web依赖添加到pom.xml配置文件中。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

下面是完整的Maven pom.xml配置文件代码:

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.ramostear</groupId>
    <artifactId>restful-webservice</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>restful-webservice</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

说明:Lombok是一个java库,可以自动插入编辑器并构建工具,使用lombok注解可以自动生成getter、setter以及构造函数等方法,你可以到Lombok官网了解更多详细信息。

1. RestController

@RestController注解用于定义RESTful Web服务,它提供JSON、XML以及自定义的相应信息,其使用语法如下:

@RestController
public class UserController{
    //TODO ...
}

2. RequestMapping

@RequestMapping注解用于定义访问REST Endpoint的请求路径。@RequestMapping的使用语法如下:

@RequestMapping("/users")
public ResponseEntity<Object> getUsers(){
    //TODO ...
}

注:@RequestMapping注解默认的请求方法GET.

在接下来的内容当中,我们将使用@RequestMapping的组合注解来定义REST Endpoint方法的映射路径:

3. RequestBody

@RequestBody注解用于定义请求正文内容类型。其语法如下:

public ResponseEntity<Object> createUser(@RequestBody User user){
    //TODO ...
}

4. PathVariable

@PathVariable注解用于定义请求路径中的动态变量,请求路径中的动态变量使用花括号“{}”包裹起来。语法如下:

@PutMapping("/users/{id}")
public ResponseEntity<Obejct> updateUser(@PathVariable("id") long id,@RequestBody User user){
    //TODO ...
}

5. GET API

默认的HTTP请求方法是GET,GET方法不需要任何的Request Body。你可以发送任何的请求参数和路径变量来定义一个动态的URL。接下来,我将演示如何定义一个HTTP GET请求方法,用于获取所有的用户信息。

package com.ramostear.restful.webservice.controller;

import com.ramostear.restful.webservice.model.User;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import javax.annotation.PostConstruct;
import java.util.HashMap;
import java.util.Map;

/**
 * @author ramostear
 * @create-time 2019/3/6 0006-3:14
 * @modify by :
 * @since:
 */
@RestController
public class UserServiceController {

    private static Map<Long,User> userRepository = new HashMap<>();

    @PostConstruct
    public void initUserRepository(){
        User admin = new User();
        admin.setId(1).setName("admin");
        userRepository.put(admin.getId(),admin);

        User editor = new User();
        editor.setId(2).setName("editor");
        userRepository.put(editor.getId(),editor);
    }

   @GetMapping("/users")
    public ResponseEntity<Object> getUser(){
        return new ResponseEntity<>(userRepository.values(), HttpStatus.OK);
    }

}

在这里,我使用了一个Hash Map来扮演用户存储库的角色,定义的请求路径是/users

6. POST API

HTTP POST请求用于创建新的资源,此方法包含了Request Body。下面我将演示如何定义HTTP POST方法来创建用户信息,并存储到用户存储库中。

package com.ramostear.restful.webservice.controller;

import com.ramostear.restful.webservice.model.User;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import javax.annotation.PostConstruct;
import java.util.HashMap;
import java.util.Map;

/**
 * @author ramostear
 * @create-time 2019/3/6 0006-3:14
 * @modify by :
 * @since:
 */
@RestController
public class UserServiceController {

    private static Map<Long,User> userRepository = new HashMap<>();

    @PostConstruct
    public void initUserRepository(){
        User admin = new User();
        admin.setId(1).setName("admin");
        userRepository.put(admin.getId(),admin);

        User editor = new User();
        editor.setId(2).setName("editor");
        userRepository.put(editor.getId(),editor);
    }


    @PostMapping("/users")
    public ResponseEntity<Object> createUser(@RequestBody User user){
        userRepository.put(user.getId(),user);
        return new ResponseEntity<>("User is created successfully",HttpStatus.CREATED);
    }
}

7. PUT API

HTTP PUT请求用于更新存储库中现有的资源,此方法包含请求正文。接下来我将给出相关示例来演示如何定义一个HTTP PUT请求方法来更新用户信息。

package com.ramostear.restful.webservice.controller;

import com.ramostear.restful.webservice.model.User;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import javax.annotation.PostConstruct;
import java.util.HashMap;
import java.util.Map;

/**
 * @author ramostear
 * @create-time 2019/3/6 0006-3:14
 * @modify by :
 * @since:
 */
@RestController
public class UserServiceController {

    private static Map<Long,User> userRepository = new HashMap<>();

    @PostConstruct
    public void initUserRepository(){
        User admin = new User();
        admin.setId(1).setName("admin");
        userRepository.put(admin.getId(),admin);

        User editor = new User();
        editor.setId(2).setName("editor");
        userRepository.put(editor.getId(),editor);
    }

    @PutMapping("/users/{id}")
    public ResponseEntity<Object> updateUser(@PathVariable(name = "id") long id,@RequestBody User user){
        userRepository.remove(id);
        user.setId(id);
        userRepository.put(id,user);
        return new ResponseEntity<>("User is updated successfully",HttpStatus.OK);
    }

}

在此方法中,定义的请求路径是/users/{id} ,其中{id}是动态的路径变量,用来定义需要更新的用户ID。

8. DELETE API

HTTP DELETE请求用于删除存储库中现有的资源,此方法不包含任何请求正文。接下来我将给出相关示例来演示如何定义一个HTTP PUT请求方法来更新用户信息。

package com.ramostear.restful.webservice.controller;

import com.ramostear.restful.webservice.model.User;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import javax.annotation.PostConstruct;
import java.util.HashMap;
import java.util.Map;

/**
 * @author ramostear
 * @create-time 2019/3/6 0006-3:14
 * @modify by :
 * @since:
 */
@RestController
public class UserServiceController {

    private static Map<Long,User> userRepository = new HashMap<>();

    @PostConstruct
    public void initUserRepository(){
        User admin = new User();
        admin.setId(1).setName("admin");
        userRepository.put(admin.getId(),admin);

        User editor = new User();
        editor.setId(2).setName("editor");
        userRepository.put(editor.getId(),editor);
    }


    @DeleteMapping("/users/{id}")
    public ResponseEntity<Object> delete(@PathVariable(name = "id") long id){
        userRepository.remove(id);
        return new ResponseEntity<>("User is deleted successfully",HttpStatus.OK);
    }

}

在此方法中,定义的请求路径是/users/{id} ,其中{id}是动态的路径变量,用来定义需要删除的用户ID。

9. 代码清单

9.1 Spring Boot应用程序主类 — RestfulWebserviceApplication.java

package com.ramostear.restful.webservice;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class RestfulWebserviceApplication {

    public static void main(String[] args) {
        SpringApplication.run(RestfulWebserviceApplication.class, args);
    }

}

9.2 POJO类 — User.java

package com.ramostear.restful.webservice.model;

import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/**
 * @author ramostear
 * @create-time 2019/3/6 0006-3:12
 * @modify by :
 * @since:
 */
@Getter
@Setter
@NoArgsConstructor
public class User {
    private long id;
    private String name;

    public User setId(long id){
        this.id = id;
        return this;
    }

    public User setName(String name){
        this.name = name;
        return this;
    }
}

9.3 Rest Controller类 — UserServiceController.java

package com.ramostear.restful.webservice.controller;

import com.ramostear.restful.webservice.model.User;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import javax.annotation.PostConstruct;
import java.util.HashMap;
import java.util.Map;

/**
 * @author ramostear
 * @create-time 2019/3/6 0006-3:14
 * @modify by :
 * @since:
 */
@RestController
public class UserServiceController {

    private static Map<Long,User> userRepository = new HashMap<>();

    @PostConstruct
    public void initUserRepository(){
        User admin = new User();
        admin.setId(1).setName("admin");
        userRepository.put(admin.getId(),admin);

        User editor = new User();
        editor.setId(2).setName("editor");
        userRepository.put(editor.getId(),editor);
    }

    @GetMapping("/users")
    public ResponseEntity<Object> getUser(){
        return new ResponseEntity<>(userRepository.values(), HttpStatus.OK);
    }

    @PostMapping("/users")
    public ResponseEntity<Object> createUser(@RequestBody User user){
        userRepository.put(user.getId(),user);
        return new ResponseEntity<>("User is created successfully",HttpStatus.CREATED);
    }

    @PutMapping("/users/{id}")
    public ResponseEntity<Object> updateUser(@PathVariable(name = "id") long id,@RequestBody User user){
        userRepository.remove(id);
        user.setId(id);
        userRepository.put(id,user);
        return new ResponseEntity<>("User is updated successfully",HttpStatus.OK);
    }

    @DeleteMapping("/users/{id}")
    public ResponseEntity<Object> delete(@PathVariable(name = "id") long id){
        userRepository.remove(id);
        return new ResponseEntity<>("User is deleted successfully",HttpStatus.OK);
    }

}

10. 测试

你可以选择命令行工具或者IDE来编译、打包并运行项目,这里我使用Intellij IDEA来运行项目,运行结果如下图所示:

接下来,我们将使用Postman应用程序来测试准备好的RESTful Web 服务接口:

  1. GET API : http://localhost:8080/users

  1. POST API : http://locahost:8080/users

  1. PUT API : http://locahost:8080/users/3

  1. DELETE API : http://localhost:8080/users/3

如何配置Spring Boot的日志记录信息?

如何配置Spring Boot的日志记录信息?

Spring Boot (五)—日志记录

Spring Boot 应用程序默认使用Apache Commons Logging来记录所有内部的日志。除此之外,Spring Boot还支持使用Java Util Longging、Log4j2和Logback来记录系统日志。我们可以通过配置相关参数,让其在控制台输出日志或者将日志写入到日志文件中。

通常情况下,如果使用Spring Boot Starter的方式引入依赖,系统将会使用Logback来记录日志,以此同时,Logback还可以和Common Logging、Util Loging、Log4j以及SLF4进行整合。

1. 日志的格式

在Spring Boot 应用程序中,默认的日志格式如下所示:

2019-03-05 02:02:00.013  INFO 7700 ---[main] .r.s.b.p.SpringBootPropertiesApplication : The following profiles are active: dev
2019-03-05 02:02:01.697  INFO 7700 --- [main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8081 (http)
2019-03-05 02:02:01.732  INFO 7700 --- [main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]

通常情况下,日志文件为我们提供了如下的几个信息:

  • 日期和时间,该日志记录的日期和时间
  • 日志级别,日志级别包括INFO、ERROR、DEBUG和WARN等
  • 进程编号,日志信息通常会包含当前的进程ID
  • —- ,信息分隔符
  • 线程名称,线程名称将使用方括号“[]”包含起来
  • 记录器名称,显示源文件类的名称
  • 日志消息

2. 控制台日志

Spring Boot应用程序在默认的情况下,“INFO”、“ERROR”和“WARN”级别的日志信息将打印到控制台窗口中,如果需要启用“DEBUG”级别的日志记录,需要在启动应用程序的时候添加日志记录级别标识命令:

java -jar jarfile.jar --debug

除此之外,也可以在applicatioin.properties或者application.yml文件中进行配置,以application.properties文件为例:

debug = true

3. 文件日志

默认情况下,所有的日志信息都将在控制台打印输出,而不会写入到日志文件中。如果需要将日志信息记录到日志文件中,则需要在application.properties或者application.yml配置文件中设置属性logging.file 或者logging.path的值。

我们可以显示的指定日志文件的存储路径,以application.properties为例,指定日志文件存储路径:

logging.path = D:\work\logging\

此时,日志文件默认的文件名称是spring.log

除了上面的配置之外,我们还可以同时指定日志文件存储路径和文件名称:

logging.file = D:\work\logging\mine-logging.log

注:一个日志文件最多能够存储10,000KB的日志信息。

4. 日志级别

Spring Boot应用程序支持所有的日志记录级别,如“TRACE”、“DEBUG”、“INFO”、”WARN”、”ERROR”、

“FATAL”以及”OFF”。你可以在配置文件中指定一个root logger:

logging.level.root = WARN

提示:Logback不支持“FATAL”级别的日志,“FATAL”级别的日志将被映射到“ERROR”级别的日志中。

5. 配置Logback

Logback支持一XML文件格式来配置Spring Boot应用程序日志。一般地、日志配置文件也应该放置在类路径下,下面给出Logback.xml文件的一个配置示例:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
 <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"></appender>
 <root level = "INFO">
    <appender-ref ref = "STDOUT"/>
 </root>
</configuration>

接下来,我们将在Spring Boot Application主类中使用slf4j logger来记录日志。首先是Logback.xml文件配置:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <appender name="STDOUT" class="cn.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>[%d{yyyy-MM-dd'T'HH:mm:ss.sss'z'}][%C][%t][%L][%-5p] %m%n</pattern>
        </encoder>
    </appender>
    <appender name="FILE" class="cn.qos.logback.core.FileAppender">
        <File>D:\work\logging\mine-log.log</File>
        <encoder>
            <pattern>[%d{yyyy-MM-dd'T'HH:mm:ss.sss'z'}][%C][%t][%L][%-5p] %m%n</pattern>
        </encoder>
    </appender>
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>

主类源代码:

package com.ramostear.spring.boot.logger;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SpringBootLoggerApplication {

    private static final Logger logger = LoggerFactory.getLogger(SpringBootLoggerApplication.class);
    public static void main(String[] args) {
        logger.info("This is a info level logger message.");
        logger.warn("This is a warn level logger message.");
        logger.error("This is a error level logger message.");
        SpringApplication.run(SpringBootLoggerApplication.class, args);
    }

}

现在,我们启动应用,观察控制台和日志文件中的内容。控制台窗口输出内容:

"C:\Program Files\Java\jdk1.8.0_144\bin\java"...
[2019-03-05T19:25:59.059Z] [com.ramostear.spring.boot.logger.SpringBootLoggerApplication] [main] [13] [INFO ] This is a info level logger message.
[2019-03-05T19:25:59.059Z] [com.ramostear.spring.boot.logger.SpringBootLoggerApplication] [main] [14] [WARN ] This is a warn level logger message.
[2019-03-05T19:25:59.059Z] [com.ramostear.spring.boot.logger.SpringBootLoggerApplication] [main] [15] [ERROR] This is a error level logger message.

接下来,我们再看看日志文件中记录的内容:

在Spring Boot程序中上传和下载文件

在Spring Boot程序中上传和下载文件

Spring Boot(十一)— 文件上传和下载

文件上传和下载是Web应用程序比较常用的功能之一,在本章节中,我将以一个简单的案例来讲解在Spring Boot中如何进行文件的上传与下载。在开始正文之前,我们通过一张思维导图来了解一下文件上传与下载的简单流程:

文件上传与下载思维导图

1. 文件上传

对于文件上传,控制器中对应的上传方法的参数必须是MultipartFile对象,MultipartFile对象可以是一个数组对象,也可以是单个对象,如果是一个数组对象,则可以进行多文件上传;这里我们仅演示单个文件上传,下面的代码展示了文件上传方法的基本结构:

@PostMapping(value = "/upload",consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
@ResponseBody
public String fileUpload(@RequestParam("file") MultipartFile file) throws IOException {
    return null;
}

接下来,我们使用FileOutputStream对象将客户端上传的文件写入到磁盘中,并返回“File is upload successfully”的提示信息,下面是文件上传完整的代码:

package com.ramostear.application.controller;

import com.ramostear.application.model.FileInfo;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import javax.annotation.PostConstruct;
import java.io.*;
import java.util.HashMap;
import java.util.Map;

/**
 * @author : ramostear
 * @date : 2019/3/8 0008-15:35
 */
@Controller
public class FileController {


    @Value ( "${file.upload.root.dir}" )
    String fileUploadRootDir;

    private static Map<String,FileInfo> fileRepository = new HashMap<>();

    @PostConstruct
    public void initFileRepository(){
        FileInfo file1 = new FileInfo ().setFileName ( "bg1.jpg" );
        FileInfo file2 = new FileInfo ().setFileName ( "bg2.jpg" );
        FileInfo file3 = new FileInfo ().setFileName ( "bg3.jpg" );
        fileRepository.put ( file1.getName (),file1 );
        fileRepository.put ( file2.getName (),file2 );
        fileRepository.put ( file3.getName (),file3 );
    }

@PostMapping(value = "/upload",consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
@ResponseBody
public String fileUpload(@RequestParam("file") MultipartFile file) throws IOException {

        File convertFile = new File ( fileUploadRootDir+file.getOriginalFilename ());
        FileOutputStream fileOutputStream = new FileOutputStream ( convertFile );
        fileOutputStream.write ( file.getBytes () );
        fileOutputStream.close ();

        FileInfo fileInfo = new FileInfo()
                .setFileName ( file.getOriginalFilename());

        fileRepository.put ( fileInfo.getName (),fileInfo);

        return "File is upload successfully";
    }
}

fileRepository用于存放已上传文件的索引信息。

2. 文件下载

在Spring Boot应用程序中,我们可以使用InputStreamResource对象来下载文件,在下载文件的方法中,我们需要通过Response来设置HttpHeander对象的相关属性,如Content-DispositionCache-ControlPragmaExpires等属性。除此之外,还需要指定Response的响应类型。下面的代码给出了文件下载的详细信息:

@GetMapping("/download/{fileName}")
@ResponseBody
public ResponseEntity<Object> downloadFile(@PathVariable(name = "fileName") String fileName) throws FileNotFoundException {

        File file = new File ( fileUploadRootDir+fileName);
        InputStreamResource resource = new InputStreamResource ( new FileInputStream ( file ) );

        HttpHeaders headers = new HttpHeaders();
        headers.add ( "Content-Disposition",String.format("attachment;filename=\"%s",fileName));
        headers.add ( "Cache-Control","no-cache,no-store,must-revalidate" );
        headers.add ( "Pragma","no-cache" );
        headers.add ( "Expires","0" );

        ResponseEntity<Object> responseEntity = ResponseEntity.ok()
                .headers ( headers )
                .contentLength ( file.length ())
                .contentType(MediaType.parseMediaType ( "application/txt" ))
                .body(resource);

        return responseEntity;
    }

3. 代码清单

3.1 文件上传和下载控制器

下面给出的是完整的文件上传和下载的代码:

package com.ramostear.application.controller;

import com.ramostear.application.model.FileInfo;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.InputStreamResource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import javax.annotation.PostConstruct;
import java.io.*;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

/**
 * @author : ramostear
 * @date : 2019/3/8 0008-15:35
 */
@Controller
public class FileController {


    @Value ( "${file.upload.root.dir}" )
    String fileUploadRootDir;

    private static Map<String,FileInfo> fileRepository = new HashMap<>();

    @PostConstruct
    public void initFileRepository(){
        FileInfo file1 = new FileInfo ().setFileName ( "bg1.jpg" );
        FileInfo file2 = new FileInfo ().setFileName ( "bg2.jpg" );
        FileInfo file3 = new FileInfo ().setFileName ( "bg3.jpg" );
        fileRepository.put ( file1.getName (),file1 );
        fileRepository.put ( file2.getName (),file2 );
        fileRepository.put ( file3.getName (),file3 );
    }

    @GetMapping("/files")
    public String files(Model model){
        Collection<FileInfo> files = fileRepository.values ();
        model.addAttribute ( "data",files );
        return "files";
    }


    @PostMapping(value = "/upload",consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
    @ResponseBody
    public String fileUpload(@RequestParam("file") MultipartFile file) throws IOException {

        File convertFile = new File ( fileUploadRootDir+file.getOriginalFilename ());
        FileOutputStream fileOutputStream = new FileOutputStream ( convertFile );
        fileOutputStream.write ( file.getBytes () );
        fileOutputStream.close ();

        FileInfo fileInfo = new FileInfo()
                .setFileName ( file.getOriginalFilename());

        fileRepository.put ( fileInfo.getName (),fileInfo);

        return "File is upload successfully";
    }

    @GetMapping("/download/{fileName}")
    @ResponseBody
    public ResponseEntity<Object> downloadFile(@PathVariable(name = "fileName") String fileName) throws FileNotFoundException {

        File file = new File ( fileUploadRootDir+fileName);
        InputStreamResource resource = new InputStreamResource ( new FileInputStream ( file ) );

        HttpHeaders headers = new HttpHeaders();
        headers.add ( "Content-Disposition",String.format("attachment;filename=\"%s",fileName));
        headers.add ( "Cache-Control","no-cache,no-store,must-revalidate" );
        headers.add ( "Pragma","no-cache" );
        headers.add ( "Expires","0" );

        ResponseEntity<Object> responseEntity = ResponseEntity.ok()
                .headers ( headers )
                .contentLength ( file.length ())
                .contentType(MediaType.parseMediaType ( "application/txt" ))
                .body(resource);

        return responseEntity;
    }



}

3.2 数据模型

创建一个文件信息数据模型作为上传文件信息的载体,下面是FileInfo.java的代码:

package com.ramostear.application.model;

import lombok.Data;

import java.util.Date;

/**
 * @author : ramostear
 * @date  : 2019/3/8 0008-15:25
 */
@Data
public class FileInfo {

    private String name;
    private Date uploadTime = new Date();

    public FileInfo setFileName(String name){
        this.setName ( name );
        return this;
    }

}

3.3 Maven build 文件

下面是本次demo应用程序的pom.xml文件配置清单:

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.ramostear</groupId>
    <artifactId>file-handling</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>file-handling</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-freemarker</artifactId>
        </dependency>
        <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>

注:本次案例使用freemarker模板引擎作为视图模板

3.4 配置文件

application.properties文件主要设置了freemarker的相关属性以及自定义的file.upload.root.dir 属性:

spring.freemarker.cache=false
spring.freemarker.prefix=
spring.freemarker.suffix=.html
spring.freemarker.enabled=true
spring.freemarker.charset=UTF-8
spring.freemarker.template-loader-path=classpath:/templates/
file.upload.root.dir = C:/work/upload/

file.upload.root.dir自定义属性设置了文件上传的更目录为:C:/work/upload/

3.5 视图

在视图文件中,创建了一个form表单用于上传文件,另外还创建了一个已上传文件列表,提供文件下载操作。

文件上传表单:

上传文件form表单

文件下载列表:

文件下载列表

说明:文件上使用的是异步上传方式进行上传,没有使用同步提交form表单的方式进行

文件上传异步操作代码如下:

$("#upload").on("click",function () {
           var fileObj = document.getElementById("file").files[0];
           var form = new FormData();
           form.append("file",fileObj);
           var xhr = new XMLHttpRequest();
           xhr.open("post","http://localhost:8080/upload",true);
           xhr.onload = function(event){
               alert(event.currentTarget.responseText);
               window.location.href = window.location.href;
           };
           xhr.send(form);
        });

4. 打包运行

使用Maven命令对应用程序进行打包,下面是maven打包的命令:

mvn clean install

在控制台窗口中运行上述命令,等待maven打包。若控制台中显示“BUILD SUCCESS”信息,你可以在当前工程目录下的target文件夹中找到相应的JAR文件。

现在,你可以使用下面的命令来运行JAR文件:

java -jar YOUR_JARFILE_NAME

JAR文件成功启动后,你可以在控制台窗口中看到如下的信息:

控制台窗口信息

5. 测试

打开浏览器并在地址栏输入:http://localhost:8080/files 。下面是成功请求后的浏览器截图:
文件列表

接下来,点击其中任意一个download按钮,测试文件下载功能是否正常:
下载文件

最后,我们测试一下文件上传功能是否正常。在进行测试之前,我们先看一下文件上传目录中存储的文件信息:

文件上传目录

接下来,我们选择一份需要上传的文件,然后点击upload按钮上传文件:

上传文件

此时,文件以及上传成功,我们再次观察文件上传目录中的文件信息,以验证文件是否成功写入磁盘:

文件上传目录对比

6. 附件

本章节的全部源代码已经上传至Github代码仓库中,你可以访问下面的地址获得全部的源码:https://github.com/ramostear/Spring-Boot-File-Handling-Tutorial