Springboot

上一篇，我们在介绍了Spring中如何使用websocket的子协议stomp，并使用简单的基于内存的stomp消息代理来编写了一个web聊天室实例。基于内存的stomp消息代理，虽然能够满足基本需求，但还是存在一些不足，比如由于stomp代理在应用内部，多个外部websocket应用需要消息互通，那么就难以满足了。在本篇，我们来学习如何使用RabbitMQ作为stomp代理。 1. 为何要使用外部消息代理 简单消息代理，能够满足单websocket应用的需要，但是如果有多个websocket应用，他们之间需要进行消息共享，那么就需要做大量的工作才能实现了。其实，MQ一个最重要的作用就在于能个在各个系统间解耦。引入外部MQ作为stomp消息代理，很好的解决了多系统消息共享的问题，只要其支持stomp协议。RabbitMQ本身提供了对STOMP的支持，加上后结构变化如下： 前边的是单应用时的结构，后边为怎么了RabbitMQ过后，多个应用程序结构。 2. RabbitMQ对STOMP的支持 RabbitMQ对stomp协议的支持是通过插件的方式，默认stomp插件是关闭的，我们需要先启用之。 2.1. 启用插件 进入rabbitmq所在服务器，然后控制台输入如下命令来启用stomp插件： ``rabbitmq-plugins enable rabbitmq_stomp`` 然后可以查看插件是否启用成功： ``rabbitmq-plugins list`` 2.2. 插件配置 默认情况下，STOMP将会监听61613端口，默认的用户名和密码都为guest。通过配置文件来配置： ubuntu下rabbitmq的配置文件在/etc/rabbitmq/rabbitmq.conf，找到stomp开头的选项，就可以进行配置了 比如配置STOMP监听端口： ``stomp.listeners.tcp.1 = 12345`` RabbitMQ中STOMP适配器连接时如果用户名和密码使用默认的guest/guest，则可以忽略，如果需要修改，则配置如下： stomp.default_user = guest stomp.default_pass = guest 2.3. Destinations STOMP规范并没有规定消息代理来支持什么样的目的地（destination），只是根据消息头的destination的值来判断消息发送的目的地，一般由消息代理自定义支持，RabbitMQ中定义了几种destination类型： #exchange[/exchange]: 发送到任意的routing key和订阅任意的binding key #queue[/queue]: 发送和订阅队列，该队列由STOMP管理 #amqqueue[/amq/queue]: 发送和订阅外部创建的队列 #topic[/topic]: 发送和订阅到topic #temptopic[/temp-queue/]: 创建临时的队列（使用reply-to请求头） 现在，我们结合代码来看看Spring中对RabbitMQ的这几类destination是如何支持的。 3. Spring中使用RabbitMQ消息代理 我们通过一个demo来看看如何在Spring中使用RabbitMQ支持的这几个destination，整体界面如下； 下边的示例仅贴上部分关键代码，完整的代码可以参看文末的源码。 首先，我们创建一个名为03-websocket-stomp-rabbitmq的springboot工程，引入如下依赖： <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-amqp</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> <dependency> <groupId>io.projectreactor</groupId> <artifactId>reactor-net</artifactId> <version>2.0.5.RELEASE</version> </dependency> <dependency> <groupId>io.netty</groupId> <artifactId>netty-all</artifactId> <version>4.0.33.Final</version> </dependency> <dependencies> ...

我们使用Spring Boot对原生WebSocket的支持来编写了一个简单的聊天室程序。它仅支持群发，如果要做到点对点消息，我们还需要编写代码自己实现。本篇，我们将使用websocket的子协议STOMP来更新我们的聊天室程序，使其可以支持单聊。 1. STOMP 1.1. 为什么要支持子协议 WebSocket是一种简单的通信协议，而并非消息协议。它是TCP之上的非常薄的一层，所做的事情仅仅是将字节流转换为消息流(文本或二进制)。至于消息是什么含义，怎么路由和解析，都交由应用程序自身来决定。HTTP协议是一种应用级协议，它明确告诉我们请求的地址、格式、编码等等信息，但是websocket与之不同，websocket并不提供详细的信息来告诉我们如何路由和处理消息。因此，对于开发大型应用程序而言，websocke级别太低了，要实现非常复杂的功能，我们需要进行大量的编码工作。这就好比，大多JAVA WEB开发都会选择使用Spring框架，而不是基于Servlet API来实现。 基于这个原因，WebSocket RFC定义了 子协议的使用规范。在握手阶段，客户端和服务端使用Sec-WebSocket-Protocol请求头来通知彼此使用子协议，即更高级的、应用级的协议。当然，也可以不使用子协议，但是客户端和服务端仍然需要定义消息的格式。使用更规范的通用消息协议，更能让应用程序开发和维护变得简单。STOMP就是这样的一个消息协议，Spring框架提供了对其的支持。 1.2. 什么是STOMP STOMP即Simple (or Streaming) Text Orientated Messaging Protocol，中文称简单(流)文本定向消息协议，它是一种简单的互操作协议**，旨在通过消息代理在客户端之间传递异步消息，STOMP协议具有简单行和互操作性，因此在多种语言和多种平台上得到广泛地应用。。 STOMP是由于需要通过脚本语言（例如Ruby，Python和Perl）连接到企业消息代理而产生的，旨在对消息进行简单的消息处理，例如可靠地发送单个消息并断开连接或在给定目的地上消耗所有消息等等。它是其他开放消息协议（例如AMQP）和JMS代理（例如OpenWire）中使用的实现特定wire protocol的替代。STOMP仅仅实现部分常用的消息API，而不是实现完整的消息API，因此更加轻量和简单。 STOMP除了支持文本消息外，也支持二进制消息，默认使用UTF-8的编码格式。 STOMP有几个比较重要的概念： frame：帧，即STOMP客户端和服务端发送的数据 COMMAND: frame的命令，由STOMP规范定义，用来表示消息的特定用途，比如连接服务端、发送消息等，每个frame都有命令 destination：消息发送的目的地址，通过消息头来表示，如destination:/topic/chat STOMP基于frame，frame的模型源于HTTP，一个frame由命令、一组可选的标头和可选的主体组成，客户端和服务端发送frame来进行通信。frame的格式如下: COMMAND header1:value1 header2:value2 Body^@ frame分为两个部分：消息头和消息体。消息头第一行为命令，然后跟key:value格式的头信息；然后是消息体，消息体跟消息头之间用一个空行分隔。最后，消息体后跟八位空字节(上文用^@表示)。另外，frame的命令和消息头信息都区分大小写。 STOMP客户端支持的命令包括：SEND、SUBSCRIBE、UNSUBSCRIBE、BEGIN、COMMIT、ABORT、ACK、NACK、DISCONNECT、CONNECT、STOMP 服务端支持的命令包括：CONNECTED、MESSAGE、RECEIPT、ERROR 只有几种消息可以包含消息体：SEND、MESSAGE、ERROR 举个例子，客户端连接到服务端，则会想服务端发送如下的frame： CONNECT accept-version:1.0,1.1,2.0 host:stomp.github.org ^@ 服务端接收连接请求则会发送下边的frame给客户端，否则发送ERROR frame： CONNECTED version:1.2 ^@ 1.3. 使用STOMP的优点 使用STOMP作为子协议，与使用原生WebSocket相比，Spring框架和Spring Security可以提供更丰富的编程模型。具体的优点有以下几点： 无需自定义消息协议和消息格式 可以使用STOMP客户端，包括Spring框架中的Java客户端 消息代理（例如RabbitMQ，ActiveMQ和其他代理）可以用于管理订阅和广播消息 可以在任意数量的@Controller中组织应用程序逻辑，并根据STOMP消息头将消息路由给它们，而对于给定的连接，可以使用单个WebSocketHandler处理原始WebSocket消息 可以使用Spring Security基于STOMP 目标（destinations）和消息类型来对消息进行安全处理 详细内容请看STOMP规范： https://stomp.github.io/stomp-specification-1.2.html 2. Spring Boot中使用STOMP 使用STOMP有如此多的好处，我们看看Spring中如何使用。 在Spring boot中使用STOMP，大概需要以下几步： ...

最近在实现任务调度服务，使用 quartz调度框架，由于使用的spring boot版本为1.5.10，该版本并没有提供quartz的starter，在集成的时候还是遇到了很多问题。本文并不会详细介绍quartz框架，请自行查阅相关资料。如果对Spring boot不太熟悉，可以看前边几篇关于spring boot的文章。 1. quartz简介 1.1. 核心概念 scheduler：任务调度器，相当于指挥中心，负责管理和调度job，由SchedulerFactory创建和关闭，创建后需要通过starter()方法来启动调度。 trigger：触发器，定义job的触发时机，通过TriggerBuilder来创建，有SimpleTrigger和CronTrigger，前者可以定义在某一个时刻触发或者周期性触发，后者使用cron表达式来定义触发时间。 Job：具体的调度业务逻辑实现，也就是任务，具体任务需要实现org.quartz.Job接口。 JobDetail：org.quartz.JobDetail用来描述Job实例的属性，并且可以通过JobDataMap传递给Job实例数据，通过JobBuilder来创建。 1.2. quartz配置 quartz框架默认会通过quartz.properties文件来加载配置信息，有几个重要的配置项： org.quartz.scheduler.*：调度器相关配置 org.quartz.threadPool.*：线程池相关配置 org.quartz.jobStore.*：quartz数据存储相关配置，在quartz中，有三种存储类型： RAMJobStore：基于内存存储job JobStoreCMT：基于数据库的数据存储，并且受运行的java容器的事务控制 JobStoreTX：基于数据库的数据存储，不受事务控制 org.quartz.dataSource.*：配置数据库存储quartz数据时的数据源信息 org.quartz.plugin.*：quartz插件相关配置 quartz简单介绍这么多，更多信息请看 这里。 2. Spring boot与quartz集成 前边说过，我使用的spring boot版本为1.5.10，没有quartz的starter，所以需要自己编码实现。同时，我还需要对quartz做持久化处理，需要在mysql库中导入quartz的建表脚本。集成步骤如下： 1、引入依赖 引入quartz的依赖包，quartz-jobs根据实际需要决定是否引入。 <dependency> <groupId>org.quartz-scheduler</groupId> <artifactId>quartz</artifactId> <version>2.2.3</version> </dependency> <dependency> <groupId>org.quartz-scheduler</groupId> <artifactId>quartz-jobs</artifactId> <version>2.2.3</version> </dependency> 2、创建表 在下载的quartz包中有建表脚本，我的为quartz-2.2.3，建表脚本在/docs/dbTables下边，导入tables_mysql_innodb.sql即可。 3、配置文件 在resources目下新建一个quartz.properties配置文件，我的配置如下： #============================================================================ # Configure Main Scheduler Properties #============================================================================ org.quartz.scheduler.instanceName:event-scheduler org.quartz.scheduler.instanceId:AUTO org.quartz.scheduler.skipUpdateCheck:true #============================================================================ # Configure ThreadPool #============================================================================ org.quartz.threadPool.class:org.quartz.simpl.SimpleThreadPool org.quartz.threadPool.threadCount:5 org.quartz.threadPool.threadPriority:5 #============================================================================ # Configure JobStore #============================================================================ org.quartz.jobStore.misfireThreshold:60000 org.quartz.jobStore.class:org.quartz.impl.jdbcjobstore.JobStoreTX org.quartz.jobStore.driverDelegateClass:org.quartz.impl.jdbcjobstore.StdJDBCDelegate org.quartz.jobStore.useProperties:false org.quartz.jobStore.tablePrefix:QRTZ_ org.quartz.jobStore.isClustered:false #============================================================================ # Configure Datasources #============================================================================ org.quartz.dataSource.ds.maxConnections:7 #============================================================================ # Configure Plugins #============================================================================ org.quartz.plugin.triggHistory.class: org.quartz.plugins.history.LoggingTriggerHistoryPlugin ...

在 Spring Boot参数验证（上）--Bean Validation及其Hibernate实现 一篇中，我们介绍了验证标准Bean Validation和其Hibernate实现，在本篇，我们看看它们是如何应用在Spring Boot Web项目中。 1. Spring Validator 其实，Spring很早就有了自己的Bean验证机制，其核心为Validator接口，表示校验器： public interface Validator { // 检测Validator是否支持校验提供的Class boolean supports(Class<?> clazz); // 校验逻辑，校验的结果信息通过errors获取 void validate(@Nullable Object target, Errors errors); } Errors接口，用以表示校验失败的错误信息： public interface Errors { // 获取被校验的根对象 String getObjectName(); // 校验结果是否有错 boolean hasErrors(); // 获取校验错误数量 int getErrorCount(); // 获取所有错误信息，包括全局错误和字段错误 List<ObjectError> getAllErrors(); // 获取所有字段错误 List<FieldError> getFieldErrors(); …… } 当Bean Validation被标准化过后，从Spring3.X开始，已经完全支持JSR 303(1.0)规范，通过Spring的LocalValidatorFactoryBean实现，它对Spring的Validator接口和javax.validation.Validator接口进行了适配。 1.1. 全局Validator 全局Validator通过上述的LocalValidatorFactoryBean类来提供，只要使用@EnableWebMvc即可（Xml配置开启<mvc:annotation-driven>），也可以进行自定义： @Configuration @EnableWebMvc public class WebConfig extends WebMvcConfigurerAdapter { @Override public Validator getValidator(); { // return "global" validator } } ...

Spring boot提供了默认的异常处理机制，但是难以满足业务需要，一般需要编码来实现自己的业务处理机制。在本篇，将介绍如何自定义异常页面，和进行全局的异常处理。 1. 全局异常处理 如果系统业务处理发生异常，我们希望能够将异常信息以友好的形式返回给调用方，而不是仅在后台记录日志，尤其是在开发RESTFul的API时，需要将业务异常信息进行明确定义并返回给API调用方，这显得尤为重要。 现在，我们来定义一个全局的业务异常类BusinessException，如果业务处理失败抛出该类或者其子类，然后编写一个全局异常处理器，将异常转换为有好的信息并返回。 1、定义异常类 public class BusinessException extends Exception { public BusinessException() { super(); } public BusinessException(String msg) { super(msg); } public BusinessException(Throwable cause) { super(cause); } public BusinessException(String message, Throwable cause) { super(message, cause); } public BusinessException(MsgDefinition msgDefinition) { super(msgDefinition.msgOf()); this.msgDef = msgDefinition; } public MsgDefinition msgDef() { return msgDef == null ? MsgDefinition.UNKOWN_ERROR : msgDef; } } 其中的MsgDefinition为具体的错误信息，包含错误码code和错误提示信息msg，子类继承该类进行扩展： public class MsgDefinition { public static final MsgDefinition SUCCESS = new MsgDefinition("0000", "请求成功"); public static final MsgDefinition EMPTY_ARGUMENTS = new MsgDefinition("4001", "请求参数为空"); public static final MsgDefinition ILLEGAL_ARGUMENTS = new MsgDefinition("4002", "请求采参数非法"); public static final MsgDefinition FILE_SIZE_OVER_LIMIT = new MsgDefinition("4301", "文件大小超过限制"); public static final MsgDefinition FILE_NUMBER_OVER_LIMIT = new MsgDefinition("4302", "文件数量超过限制"); public static final MsgDefinition FILE_FORMAT_UNSUPPORTED = new MsgDefinition("4310", "文件格式不支持"); public static final MsgDefinition UNKOWN_ERROR = new MsgDefinition("9999", "系统未知异常"); private String code; private String msg; public MsgDefinition(String code, String msg) { this.code = code; this.msg = msg; } public String codeOf() { return this.code; } public String msgOf() { return this.msg; } @Override public String toString() { return JsonUtil.toJson(this); } } ...

在上一篇SpringBoot-工程结构、配置文件以及打包中，我们介绍了Spring Boot项目的工程结构、基本配置、使用IDEA开发的配置，以及可执行jar包的结构和打包方式，对Spring Boot的项目有了整体的认识。在本篇，我们将介绍JPA的使用。 1. 简介 百度百科对JPA的解释是这样的： JPA是Java Persistence API的简称，中文名Java持久层API，是JDK 5.0注解或XML描述对象－关系表的映射关系，并将运行期的实体对象持久化到数据库中。 JPA由EJB 3.0软件专家组开发，作为JSR-220实现的一部分。但它又不限于EJB 3.0，你可以在Web应用、甚至桌面应用中使用。JPA的宗旨是为POJO提供持久化标准规范。Hibernate3.2+、TopLink 10.1.3以及OpenJPA都提供了JPA的实现。 简单来说，Hibernate这种ORM的持久化框架的出现极大的简化了数据库持久层的操作，随着使用人数的增多，ORM的概念越来越深入人心。因此，JAVA专家组结合Hibernate，提出了JAVA领域的ORM规范，即JPA。 JPQL 其实同Hibernate的HQL类似，是JPA标准的面向对象的查询语言。百度百科的解释如下： JPA是Java Persistence API的简称，中文名Java持久层API，是JDK 5.0注解或XML描述对象－关系表的映射关系，并将运行期的实体对象持久化到数据库中。 JPA由EJB 3.0软件专家组开发，作为JSR-220实现的一部分。但它又不限于EJB 3.0，你可以在Web应用、甚至桌面应用中使用。JPA的宗旨是为POJO提供持久化标准规范。Hibernate3.2+、TopLink 10.1.3以及OpenJPA都提供了JPA的实现。 JPA与Hibernate的关系 JPA是参考Hibernate提出的Java持久化规范，而Hibernate全面兼容JPA，是JPA的一种标准实现。 JPA与Spring Data JPA Spring Boot对JPA的支持其实使用的是Spring Data JPA，它是Spring对JPA的二次封装，默认实现使用的是Hibernate，支持常用的功能，如CRUD、分页、条件查询等，同时也提供了强大的扩展能力。 2. HelloWorld 僚机了JPA的概念过后，接下来，我们使用Spring Boot工程来实现一个最简单的CRUD操作，看看使用JPA我们需要做哪些事情。 引入依赖 直接引入如下依赖： <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> ...

前一篇，我们简单介绍了SpringBoot的概念，然后逐步构建了一个HelloWorld的Web应用。现在，我们来整体认识一下SpringBoot，包括：工程结构、配置文件、可执行Jar包等。 1. 工程结构 本质上而言，SpringBoot是一个遵循Maven标准的Maven工程，但是如果开发的是Web项目，与标准Maven存在一定的差别：默认情况下，SpringBoot打包为jar（简单方便，使用自带容器，不需要部署到tomcat等java容器，当然也可以打包为可执行war），此时，不能使用Maven的webapp目录来存放web资源（js、css、图片、页面等），SpringBoot有一套自己的规范，整个工程结构如下： \---src +---main | +---java // java后台代码 | \---resources // 资源文件目录 | application.properties // 配置文件 | +---static // 存放静态文件，如js、css、图片等 | \---templates // 存放模板文件 \---test \---java // 测试代码 默认情况下，Spring boot规定将静态资源存放到resources/static目录，而页面存放到resources/templates目录，也可以通过配置文件修改默认存放目录。 2. 代码结构 Spring Boot推荐的后台代码结构如下： +---src | +---main | | +---java | | | \---com | | | \---belonk | | | | WebappViewStarter.java // 包含main方法的启用类 | | | +---config | | | | CustomParamConfig.java | | | | RandomParamConfig.java | | | +---domain | | | +---service | | | \---web | | | HomeController.java ...

最近在了解微服务和Spring Cloud相关的东西，Spring Cloud的微服务体系基于Spring boot，所以了解Spring Boot是前提和基础。本文将介绍Spring Boot基础内容，包括简介、环境搭建、示例代码等，所使用JDK版本为JDK8，构建工具为Maven3.5。 1. 简介 Spring Boot是Spring的开源项目，其目的是让开发者可以简单、快速地使用Spring框架创建生产级的应用，其目的不是为了替换Spring，而是简化Spring的使用。Spring Boot可以看做是对Spring框架的二次封装，不过，在封装的同时也还提供了许多高级功能。 Spring Boot特性如下： 创建独立的Spring应用程序 直接嵌入Tomcat、Jetty或Undertow(无需部署WAR文件) 为项目构建提供了许多的“starter”，适用于整合不同的框架，从而简化您的构建工具（Maven）配置 尽可能自动配置Spring 提供可生产的特性，如度量指标、健康检查和集中配置 绝对没有代码生成，也不需要XML配置 2. 系统需求 Spring Boot需要JDK8或以上版本，嵌入的tomcat8.5所支持的Servlet版本为3.1，如下表所示： 依赖 版本 JDK 8或以上版本 Maven 3.2或以上版本 Servlet 3.1+ 3. 构建应用 现在，我们来一步步构建一个Hello world应用。 3.1. 构建 Spring Boot项目是基于Maven构建，完全遵循Maven的项目构建规则和目录规范。所以，你可以直接使用开发工具或者maven命令行来创建Spring Boot项目。需要注意的饿是，如果是Web项目，而且打包的格式为jar，那么与标准Maven项目不同的是不能使用src/main/webapp目录。 也可以访问 https://start.spring.io/来快速构建应用，选择对应的构建工具、语言和版本信息，填写开发信息并加入依赖下载，然后导入开发工具即可： 3.2. 配置Pom.xml 应用创建好了，我们来配置pom.xml，引入Spring boot相关的依赖。 1、继承parent节点 Spring为我们提供了顶层的parent节点，用来定义Spring Boot使用的版本，配置如下： <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.10.RELEASE</version> <relativePath/> </parent> ...