Spring学习笔记 Spring Roo 简介

一直以来,Java/Spring开发被认为是笨重的代表,无法快速生成项目原型和骨架。所以,Spring推出了Spring Roo这个项目,帮助我们快速生成项目原型。本文参考自Spring Roo的官方文档,如果熟悉英文的话可以直接看原文档,内容更加丰富。

安装

安装命令行工具

Spring Roo是一套命令行工具,如果你使用的是Eclipse/STS,还可以使用Eclipse对应的插件。

首先先来下载命令行工具。到下载页面,选择对应版本下载。这里我选择的是最新的2.0.0.RC1 ,毕竟我有更新强迫症。下载完成之后解压,会得到一个文件夹,其中bin目录下就是Spring Roo的可执行文件了。可以看到它有batsh两种格式,可以在不同系统上运行。为了方便以后在终端窗口运行,我建议同时将这个文件夹添加到环境变量中。

安装好之后,打开命令提示符或者其他终端窗口,输入roo命令,就可以启动Roo了。值得提一点,Roo会在命令提示符对应的文件夹位置创建项目,所以如果需要在特定位置创建项目,先在命令提示符中切换到该文件夹,然后再启动Roo。

安装Eclipse插件

打开你的Eclipse/STS,然后遵循以下步骤:

  1. 点击菜单栏 Help ▸ Install New Software
  2. 点击 Available Software sites
  3. 点击 Import 按钮
  4. 找到 “$ROO_HOME/conf/sts-sites-bookmarks.xml” 并确定,这里$ROO_HOME是你安装Roo的目录
  5. 根据需要选择对应的版本
  6. 在过滤栏输入roo
  7. 选中功能 Spring IDE Roo Support
  8. 然后一路确定并允许条款
  9. 最后重启IDE即可

下面是官方文档的图,如果有疑问照着这张图来就行了。

到这一步还没完,插件是安装好了,但是还没有配置。其实要配置的也很简单,告诉插件你的Roo工具安装到哪里就行了。点击 Window ▸ Preferences ▸ Spring ▸ Roo Support ,打开设置,然后照着官方文档截图设置好你的工具路径即可。

这样插件就设置完毕了。其实这个插件也没啥作用,就是在Eclipse中开了一个窗口,能运行Roo命令,和直接在命令提示符中运行其实是一样的。

使用Roo

运行Roo脚本

$ROO_HOME\samples文件夹下有三个示例项目脚本,使用Roo运行它们可以快速创建相应的项目。如果没有耐心,可以直接从这里开始。

比如说,我要运行clinic实例项目,就可以输入以下命令:

roo> script --file clinic.roo

稍等片刻,程序就会创建完毕。

最后创建出的是一个基于Maven的Spring Boot程序。在IDEA下是这么一个样子。可以看到项目中有一个名字叫log.roo的日志文件,它记录了这个Roo脚本执行的内容。另外不知道为什么程序在IDEA下会有一点报错,不过不影响编译和运行。

这个PetClinic示例程序使用了Spring Security来保护页面。我查阅了一下,Spring Boot下Spring Security默认的用户名是user,密码则在程序启动的时候随机输出到控制台中。最后运行截图如下,大家可以自己运行和测试一下这个程序。

脚本解释

下面来解释一下PetClinic这个程序的Roo脚本,让我们来看看Roo是如何工作的。这里只做一下简单解释,如果需要详细资料的话可以参考官方文档的附录,完整介绍了Roo的各种命令和参数以及用法。

首先是创建项目并指定顶级包名,这样会创建一个基于Maven的Spring Boot项目。

project setup --topLevelPackage org.springframework.roo.petclinic

然后是指定JPA存储类型,这里用的是Hibernate,数据库是存储在内存的HSQLDB。当然也可以使用其它数据库,不过相应地需要增加用户名等其他参数。

jpa setup --provider HIBERNATE --database HYPERSONIC_IN_MEMORY

然后是几个枚举类,将会在实体类中用到,这里的~指代前面设置的顶级包名。

enum type --class ~.domain.reference.PetType
enum constant --name DOG
enum constant --name CAT
enum constant --name BIRD

enum type --class ~.domain.reference.Specialty
enum constant --name CARDIOLOGY
enum constant --name DENTISTRY
enum constant --name NUTRITION

然后是项目中的几个实体类。

entity jpa --class ~.domain.Pet --sequenceName PET_SEQ --entityFormatExpression "#{name} (#{type})"
entity jpa --class ~.domain.Visit --sequenceName VISIT_SEQ --entityFormatMessage visit_format
entity jpa --class ~.domain.AbstractPerson --abstract 
entity jpa --class ~.domain.Vet --extends ~.domain.AbstractPerson --entityFormatExpression "#{lastName} (#{specialty})"
entity jpa --class ~.domain.Owner --extends ~.domain.AbstractPerson --entityFormatExpression "#{lastName} (#{city})"

之后的叫本详细设置了每个实体类的属性以及对应关系,由于比较多所以我只挑选了几个典型的。在设置实体类之前,需要使用focus命令指定要设置的实体类。

focus --class ~.domain.Pet
field boolean --fieldName sendReminders --notNull --primitive
field string --fieldName name --notNull --sizeMin 1
field number --fieldName weight --type java.lang.Float --notNull --min 0
field enum --fieldName type --type ~.domain.reference.PetType --notNull
field set --fieldName visits --type ~.domain.Visit

focus --class ~.domain.AbstractPerson
field string --fieldName firstName --sizeMin 3 --sizeMax 30
field string --fieldName lastName --notNull --sizeMin 3 --sizeMax 30
field string --fieldName address --notNull --sizeMax 50 --sizeMin 1
field string --fieldName city --notNull --sizeMax 30
field string --fieldName telephone --notNull
field string --fieldName homePage --sizeMax 30
field string --fieldName email --sizeMax 30 --sizeMin 6
field date --fieldName birthDay --type java.util.Date --notNull

然后设置实体类之间的投影关系并设置JPA Repository。

entity projection --class ~.domain.VetInfo --entity ~.domain.Vet --fields id,firstName,lastName,specialty --entityFormatExpression "#{firstName} #{lastName}"
repository jpa --entity ~.domain.Vet --interface ~.repository.VetRepository --defaultReturnType ~.domain.VetInfo

repository jpa --all --package ~.repository
service --all --apiPackage ~.service.api --implPackage ~.service.impl

然后是设置DTO(数据传输对象),它和页面中的表单等信息对应,然后在后台转换为相应的实体类。在这里还可以指定finder,也就是查询条件,查询条件的规则请参考Spring Data JPA的相关内容。

dto --class ~.domain.PetNameAndWeightFormBean
field string --fieldName name
field number --fieldName weight --type java.lang.Float
finder add --entity ~.domain.Pet --name findByNameAndWeight --formBean ~.domain.PetNameAndWeightFormBean

然后是设置Spring Web MVC,这里指定Thymeleaf作为视图层,并为所有控制器生成JSON和Thymeleaf视图。

web mvc setup
web mvc view setup --type THYMELEAF
web mvc controller --all --responseType JSON
web mvc controller --all --responseType THYMELEAF

然后是生成查询和详情页面。这里针对前面设置的所有查询条件生成相应的查询页面,然后生成指定实体类的详情页面。最后指定了页面语言,目前好像只支持英语和西班牙语。

// Publishing finders
web mvc finder --all --responseType THYMELEAF

// Adding details
web mvc detail --entity ~.domain.Owner --field pets --views list,show,findByCityLike --responseType THYMELEAF
web mvc detail --all --views list,show --responseType THYMELEAF

web mvc language --code es

然后使用了Spring Security保护了一下程序。第一行的是使用Spring Security的默认配置,用户名是user,密码是打印在控制台的随机字符串。第二行配置了一下用户权限,只有管理员角色的用户才能执行删除操作。

security setup --provider DEFAULT

security authorize --class ~.service.impl.OwnerServiceImpl --method delete.* --roles ADMIN

然后启用了审计功能,程序会自动记录相应实体类的编辑时间和编辑者。

jpa audit setup
jpa audit add --entity ~.domain.Pet
jpa audit add --entity ~.domain.Owner
jpa audit add --entity ~.domain.Visit
jpa audit add --entity ~.domain.Vet

然后启用了Web服务端点功能,这些端点可以在/servicesURL下查看。

ws endpoint --service ~.service.api.OwnerService --sei ~.ws.api.OwnerWebService --class ~.ws.endpoint.OwnerWebServiceEndpoint --config ~.config.WsEndpointsConfiguration
ws endpoint --service ~.service.api.PetService --sei ~.ws.api.PetWebService --class ~.ws.endpoint.PetWebServiceEndpoint --config ~.config.WsEndpointsConfiguration

最后自动为这些实体类和服务生成单元测试和集成测试。

// Generating unitary tests for all entities
test unit --class ~.domain.Owner
test unit --class ~.domain.Pet
test unit --class ~.domain.Vet
test unit --class ~.domain.Visit

// Repository integration tests
test integration --class ~.repository.VetRepository
test integration --class ~.repository.OwnerRepository
test integration --class ~.repository.VisitRepository
test integration --class ~.repository.PetRepository

// Controller integration tests
test integration --class ~.web.OwnersCollectionJsonController
test integration --class ~.web.PetsItemJsonController
test integration --class ~.web.VetsCollectionThymeleafController
test integration --class ~.web.VisitsItemThymeleafController

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏hbbliyong

Spring Boot 设置静态资源访问

问题描述 当使用spring Boot来架设服务系统时,有时候也需要用到前端页面,当然就不可或缺地需要访问其他一些静态资源,比如图片、css、js等文件。那么如...

333100
来自专栏大魏分享(微信公众号:david-share)

重点来了:事务一致性的深入研究&EJB的全生命周期 | 从开发角度看应用架构5

14440
来自专栏Java编程技术

Springboot模块分类

springboot可以依据classpath里面的依赖的内容来自动配置bean到IOC容器,但是要开启这个自动配置功能需要添加@EnableAutoConfi...

9010
来自专栏运维

Redis3.0.7集群部署完整版

Redis集群没有出来前,一直使用Codis集群,现在部署Redis集群看看效果如何。

28020
来自专栏猿天地

Netty-整合Protobuf高性能数据传输

前言 本篇文章是Netty专题的第四篇,前面三篇文章如下: 高性能NIO框架Netty入门篇 高性能NIO框架Netty-对象传输 高性能NIO框架Netty-...

330110
来自专栏JackieZheng

Spring集成RabbitMQ-使用RabbitMQ更方便

如果提到Spring,你脑海中对他的印象还停留在SSH三大框架之一,那或许你该好好重新认识这个家伙。 在IT技术日新月异的今天,他还能让你忘不了并与他朝夕相处,...

21290
来自专栏NetCore

AppFuse项目笔记(1)

AppFuse项目笔记(1) 一、Appfuse简介 Appfuse是Matt Raible 开发的一个指导性的入门级J2EE框架,它对如何集成流行的Sprin...

33850
来自专栏猿天地

Spring Boot 使用WebAsyncTask异步返回结果

在Spring Boot中(Spring MVC)下请求默认都是同步的,一个请求过去到结束都是由一个线程负责的,很多时候为了能够提高吞吐量,需要将一些操作异步化...

49520
来自专栏从零开始学自动化测试

pytest文档3-pycharm运行pytest

上一篇pytest文档2-用例运行规则已经介绍了如何在cmd执行pytest用例,平常我们写代码在pycharm比较多 写完用例之后,需要调试看看,是不是能正常...

43330
来自专栏王清培的专栏

spring rest 容易被忽视的后端服务 chunked 性能问题

spring boot 容易被忽视的后端服务 chunked 性能问题 标签(空格分隔): springboot springmvc chunked 背景 sp...

54180

扫码关注云+社区

领取腾讯云代金券