Spring Boot之Web综合开发

Web开发

Spring Boot Web 开发非常的简单,其中包括常用的 json 输出、filters、数据库、property、log 等

Json接口开发

在以前使用 Spring 开发项目,需要提供 json 接口时需要做哪些配置呢

  • 添加 jackjson 等相关 jar包
  • 配置 Spring Controller 扫描
  • 对接的方法添加 @ResponseBody
1
2
3
4
5
6
7
8
9
10
@RestController
public class HelloController {
@RequestMapping("/getUser")
public User getUser() {
User user=new User();
user.setUserName("Joe.Ye");
user.setPassWord("xxxx");
return user;
}
}

自定义Filter

我们常常在项目中会使用 filters 用于录调用日志、排除有 XSS 威胁的字符、执行权限验证等等。Spring Boot 自动添加了 OrderedCharacterEncodingFilter 和 HiddenHttpMethodFilter,并且我们可以自定义 Filter。

两个步骤:

  • 实现 Filter 接口,实现 Filter 方法
  • 添加@Configuration 注解,将自定义Filter加入过滤链
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
@Configuration
public class WebConfiguration {
@Bean
public RemoteIpFilter remoteIpFilter() {
return new RemoteIpFilter();
}

@Bean
public FilterRegistrationBean testFilterRegistration() {
FilterRegistrationBean registration = new FilterRegistrationBean();
registration.setFilter(new MyFilter());
registration.addUrlPatterns("/*");
registration.addInitParameter("paramName", "paramValue");
registration.setName("MyFilter");
registration.setOrder(1);
return registration;
}

public class MyFilter implements Filter {
@Override
public void destroy() {

}

@Override
public void doFilter(ServletRequest srequest, ServletResponse sresponse, FilterChain filterChain)
throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) srequest;
System.out.println("This is MyFilter, url: " + request.getRequestURI());
filterChain.doFilter(srequest, sresponse);
}

@Override
public void init(FilterConfig arg0) throws ServletException {

}
}
}

数据库操作

Jpa 是利用 Hibernate 生成各种自动化的 sql,如果只是简单的增删改查,Spring 内部已经封装实现。

添加相 jar 包

1
2
3
4
5
6
7
8
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>

添加配置文件

1
2
3
4
5
6
7
8
spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

spring.jpa.properties.hibernate.hbm2ddl.auto=update
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect
spring.jpa.show-sql= true

(1)hibernate.hbm2ddl.auto参数主要用于:自动创建、更新、验证数据库表结构,有四个值:

  • create: 每次加载 hibernate 时都会删除上一次的生成的表,然后根据你的 model 类再重新来生成新表,哪怕两次没有任何改变也要这样执行,这就是导致数据库表数据丢失的一个重要原因
  • create-drop:每次加载 hibernate 时根据 model 类生成表,但是 sessionFactory 一关闭,表就自动删除
  • update:最常用的属性,第一次加载 hibernate 时根据 model 类会自动建立起表的结构(前提是先建立好数据库),以后加载 hibernate 时根据 model 类自动更新表结构,即使表结构改变,表中的行仍然存在不会删除以前的行。要注意的是当部署到服务器后,表结构是不会被马上建立起来的,是要等应用第一次运行起来后才会
  • validate:每次加载 hibernate 时,验证创建数据库表结构,只会和数据库中的表进行比较,不会创建新表,但是会插入新值。

(2)hibernate.dialect参数主要是指定生成表名的存储引擎为 InnoDBD

(3)show-sql参数设置是否打印出自动生成的 SQL,方便调试的时候查看

添加实体类和 Dao

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
@Entity
public class User implements Serializable {

private static final long serialVersionUID = 1L;
@Id
@GeneratedValue
private Long id;
@Column(nullable = false, unique = true)
private String userName;
@Column(nullable = false)
private String passWord;
@Column(nullable = false, unique = true)
private String email;
@Column(nullable = true, unique = true)
private String nickName;
@Column(nullable = false)
private String regTime;

//省略getter settet方法、构造方法

}

dao 只要继承 JpaRepository 类就可以,几乎可以不用写方法,还可以根据方法名来自动的生成 SQL,比如findByUserName 会自动生成一个以 userName 为参数的查询方法,比如 findAlll 自动会查询表里面的所有数据,比如自动分页等等

Entity 中不映射成列的字段得加 @Transient 注解,不加注解会映射成列

1
2
3
4
public interface UserRepository extends JpaRepository<User, Long> {
User findByUserName(String userName);
User findByUserNameOrEmail(String username, String email);
}

测试

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(Application.class)
public class UserRepositoryTests {

@Autowired
private UserRepository userRepository;

@Test
public void test() throws Exception {
Date date = new Date();
DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.LONG);
String formattedDate = dateFormat.format(date);

userRepository.save(new User("aa", "aa@appbolg.cn", "AA", "a123456", formattedDate));
userRepository.save(new User("bb", "bb@appbolg.cn", "BB", "b123456", formattedDate));
userRepository.save(new User("cc", "cc@appbolg.cn", "CC", "c123456", formattedDate));

Assert.assertEquals(9, userRepository.findAll().size());
Assert.assertEquals("BB", userRepository.findByUserNameOrEmail("bb", "cc@appbolg.cn").getNickName());
userRepository.delete(userRepository.findByUserName("aa"));
}

}

当让 Spring Data Jpa 还有很多功能,比如封装好的分页,可以自己定义 SQL,主从分离等等

自定义Property

在 Web 开发的过程中,我经常需要自定义一些配置文件,在 application.properties 中进行配置

1
2
cn.appblog.title=App开发技术博客
cn.appblog.description=http://www.appblog.cn

自定义配置类

1
2
3
4
5
6
7
8
9
@Component
public class AppBlogProperties {
@Value("${cn.appblog.title}")
private String title;
@Value("${cn.appblog.description}")
private String description;

//省略getter settet方法
}

log配置

配置输出的地址和输出级别

1
2
3
4
logging.path=/user/local/log
logging.level.com.favorites=DEBUG
logging.level.org.springframework.web=INFO
logging.level.org.hibernate=ERROR

path为本机的log地址,logging.level后面可以根据包路径配置不同资源的log级别

Thymeleaf模板

Spring Boot 推荐使用 Thymeleaf 来代替 Jsp

Thymeleaf 介绍

Thymeleaf 是一款用于渲染 XML/XHTML/HTML5 内容的模板引擎。类似 JSP,Velocity,FreeMaker 等,它也可以轻易的与 Spring MVC 等 Web 框架进行集成作为 Web 应用的模板引擎。与其它模板引擎相比,Thymeleaf 最大的特点是能够直接在浏览器中打开并正确显示模板页面,而不需要启动整个 Web 应用。

Thymeleaf 是与众不同的,因为它使用了自然的模板技术。这意味着 Thymeleaf 的模板语法并不会破坏文档的结构,模板依旧是有效的XML文档。模板还可以用作工作原型,Thymeleaf 会在运行期替换掉静态值。Velocity 与 FreeMarke则是连续的文本处理器。 下面的代码示例分别使用 Velocity、FreeMarker 与 Thymeleaf 打印出一条消息:

1
2
3
Velocity: <p>$message</p>
FreeMarker: <p>${message}</p>
Thymeleaf: <p th:text="${message}">Hello World!</p>

注意,由于 Thymeleaf 使用了 XML DOM 解析器,因此它并不适合于处理大规模的 XML 文件。

URL

URL 在 Web 应用模板中占据着十分重要的地位,需要特别注意的是 Thymeleaf 对于 URL 的处理是通过语法 @{...} 来处理的。Thymeleaf 支持绝对路径 URL:

1
<a th:href="@{http://www.thymeleaf.org}">Thymeleaf</a>

条件求值

1
<a th:href="@{/login}" th:unless=${session.user != null}>Login</a>

for循环

1
2
3
4
5
<tr th:each="prod : ${prods}">
<td th:text="${prod.name}">Onions</td>
<td th:text="${prod.price}">2.41</td>
<td th:text="${prod.inStock}? #{true} : #{false}">yes</td>
</tr>

页面即原型

在 Web 开发过程中一个绕不开的话题就是前端工程师与后端工程师的协作,在传统 Java Web 开发过程中,前端工程师和后端工程师一样,也需要安装一套完整的开发环境,然后各类 Java IDE 中修改模板、静态资源文件,启动/重启/重新加载应用服务器,刷新页面查看最终效果。

但实际上前端工程师的职责更多应该关注于页面本身而非后端,使用 JSP,Velocity 等传统的 Java 模板引擎很难做到这一点,因为它们必须在应用服务器中渲染完成后才能在浏览器中看到结果,而 Thymeleaf 从根本上颠覆了这一过程,通过属性进行模板渲染不会引入任何新的浏览器不能识别的标签,例如 JSP 中的 ,不会在 Tag 内部写表达式。整个页面直接作为 HTML 文件用浏览器打开,几乎就可以看到最终的效果,这大大解放了前端工程师的生产力,它们的最终交付物就是纯的 HTML/CSS/JavaScript 文件。

Gradle 构建工具

Spring 项目建议使用 Maven/Gradle 进行构建项目,相比 Maven 来讲 Gradle 更简洁,而且 Gradle 更适合大型复杂项目的构建。Gradle 吸收了 Maven 和 Ant 的特点而来,不过目前 Maven 仍然是 Java 界的主流。

一个使用 Gradle 配置的项目

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
buildscript {
repositories {
maven { url "http://repo.spring.io/libs-snapshot" }
mavenLocal()
}
dependencies {
classpath("org.springframework.boot:spring-boot-gradle-plugin:1.3.6.RELEASE")
}
}

apply plugin: 'java' //添加 Java 插件, 表明这是一个 Java 项目
apply plugin: 'spring-boot' //添加 Spring-boot支持
apply plugin: 'war' //添加 War 插件, 可以导出 War 包
apply plugin: 'eclipse' //添加 Eclipse 插件, 添加 Eclipse IDE 支持, Intellij Idea 为 "idea"

war {
baseName = 'favorites'
version = '0.1.0'
}

sourceCompatibility = 1.7 //最低兼容版本 JDK1.7
targetCompatibility = 1.7 //目标兼容版本 JDK1.7

repositories { //Maven 仓库
mavenLocal() //使用本地仓库
mavenCentral() //使用中央仓库
maven { url "http://repo.spring.io/libs-snapshot" } //使用远程仓库
}

dependencies { // 各种依赖的jar包
compile("org.springframework.boot:spring-boot-starter-web:2.1.3.RELEASE")
compile("org.springframework.boot:spring-boot-starter-thymeleaf:2.1.3.RELEASE")
compile("org.springframework.boot:spring-boot-starter-data-jpa:2.1.3.RELEASE")
compile group: 'mysql', name: 'mysql-connector-java', version: '5.1.47'
compile group: 'org.apache.commons', name: 'commons-lang3', version: '3.8.1'
compile("org.springframework.boot:spring-boot-devtools:2.1.3.RELEASE")
compile("org.springframework.boot:spring-boot-starter-test:2.1.3.RELEASE")
compile 'org.webjars.bower:bootstrap:4.3.1'
compile 'org.webjars.bower:jquery:3.3.1'
compile("org.webjars:vue:2.6.9")
compile 'org.webjars.bower:vue-resource:1.5.1'

}

bootRun {
addResources = true
}

WebJars

WebJars 可以以 Jar 包的形式来使用前端的各种框架、组件。

什么是WebJars

WebJars 是将客户端(浏览器)资源(JavaScript,Css等)打成 Jar 包文件,以对资源进行统一依赖管理。WebJars 的 Jar 包部署在 Maven 中央仓库上。

我们在开发 Java web 项目的时候会使用像 Maven,Gradle 等构建工具以实现对 Jar 包版本依赖管理,以及项目的自动化管理,但是对于 JavaScript,Css 等前端资源包,我们只能采用拷贝到 webapp 下的方式,这样做就无法对这些资源进行依赖管理。那么 WebJars 就以 Jar 包形式提供给我们这些前端资源,以便进行依赖管理。

如何使用WebJars、

(1)WebJars主官网 查找对于的组件,比如 Vuejs

1
2
3
4
5
<dependency>
<groupId>org.webjars</groupId>
<artifactId>vue</artifactId>
<version>2.6.9</version>
</dependency>

(2)页面引入

1
<link th:href="@{/webjars/bootstrap/4.3.1/dist/css/bootstrap.css}" rel="stylesheet"></link>

Powered by AppBlog.CN     浙ICP备14037229号

Copyright © 2012 - 2020 APP开发技术博客 All Rights Reserved.

访客数 : | 访问量 :