Spring Boot Ajax 详解
Spring Boot Ajax示例
本文将向您展示如何使用jQuery.ajaxHTML表单请求发送Spring REST API并返回JSON响应。
使用的工具 ：
- Spring Boot 1.5.1.RELEASE
- 春季4.3.6.RELEASE
- Maven 3
- jQuery的
- Bootstrap 3
注意
您可能会对这个经典的Spring MVC Ajax示例感兴趣
1.项目结构
标准的Maven项目结构。
2.项目依赖
一个正常的Spring Boot依赖项和一些webjars资源。
pom.xml
4.0.0
com.mkyong
spring-boot-ajax-example
jar
1.0
org.springframework.boot
spring-boot-starter-parent
1.5.1.RELEASE
1.8
org.springframework.boot
spring-boot-starter-thymeleaf
org.springframework.boot
spring-boot-devtools
true
org.webjars
jquery
2.2.4
org.webjars
bootstrap
3.3.7
org.springframework.boot
spring-boot-maven-plugin
3. Spring REST API
3.1一个REST控制器，接受SearchCriteria并返回一个ResponseEntity
SearchController.java
package com.mkyong.controller;
import com.mkyong.model.AjaxResponseBody;
import com.mkyong.model.SearchCriteria;
import com.mkyong.model.User;
import com.mkyong.services.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.Errors;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
import java.util.List;
import java.util.stream.Collectors;
@RestController
public class SearchController {
UserService userService;
@Autowired
public void setUserService(UserService userService) {
this.userService = userService;
}
@PostMapping("/api/search")
public ResponseEntity getSearchResultViaAjax(
@Valid @RequestBody SearchCriteria search, Errors errors) {
AjaxResponseBody result = new AjaxResponseBody();
//If error, just return a 400 bad request, along with the error message
if (errors.hasErrors()) {
result.setMsg(errors.getAllErrors()
.stream().map(x -> x.getDefaultMessage())
.collect(Collectors.joining(",")));
return ResponseEntity.badRequest().body(result);
}
List users = userService.findByUserNameOrEmail(search.getUsername());
if (users.isEmpty()) {
result.setMsg("no user found!");
} else {
result.setMsg("success");
}
result.setResult(users);
return ResponseEntity.ok(result);
}
}
3.2一些POJO。
AjaxResponseBody.java
package com.mkyong.model;
import java.util.List;
public class AjaxResponseBody {
String msg;
List result;
//getters and setters
}
User.java
package com.mkyong.model;
public class User {
String username;
String password;
String email;
public User(String username, String password, String email) {
this.username = username;
this.password = password;
this.email = email;
}
//getters and setters
}
3.3验证。
SearchCriteria.java
package com.mkyong.model;
import org.hibernate.validator.constraints.NotBlank;
public class SearchCriteria {
@NotBlank(message = "username can't empty!")
String username;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
}
3.4初始化某些用户进行搜索的服务。
UserService.java
package com.mkyong.services;
import com.mkyong.model.User;
import org.springframework.stereotype.Service;
import javax.annotation.PostConstruct;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;
@Service
public class UserService {
private List users;
// Love Java 8
public List findByUserNameOrEmail(String username) {
List result = users.stream()
.filter(x -> x.getUsername().equalsIgnoreCase(username))
.collect(Collectors.toList());
return result;
}
// Init some users for testing
@PostConstruct
private void iniDataForTesting() {
users = new ArrayList();
User user1 = new User("mkyong", "password111", "[email protected]");
User user2 = new User("yflow", "password222", "[email protected]");
User user3 = new User("laplap", "password333", "[email protected]");
users.add(user1);
users.add(user2);
users.add(user3);
}
}
3.5 Spring Boot Starter。
UserService.java
package com.mkyong;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class SpringBootWebApplication {
public static void main(String[] args) throws Exception {
SpringApplication.run(SpringBootWebApplication.class, args);
}
}
4. HTML表单+ jQuery Ajax
4.1一个简单的HTML表单，用bootstrap装饰。
ajax.html
Spring Boot ajax example
Spring Boot AJAX Example
4.2获取HTML表单，将搜索条件转换为JSON格式JSON.stringify，并通过发送POST请求jQuery.ajax
main.js
$(document).ready(function () {
$("#search-form").submit(function (event) {
//stop submit the form, we will post it manually.
event.preventDefault();
fire_ajax_submit();
});
});
function fire_ajax_submit() {
var search = {}
search["username"] = $("#username").val();
$("#btn-search").prop("disabled", true);
$.ajax({
type: "POST",
contentType: "application/json",
url: "/api/search",
data: JSON.stringify(search),
dataType: 'json',
cache: false,
timeout: 600000,
success: function (data) {
var json = "Ajax Response
"
+ JSON.stringify(data, null, 4) + "";
$('#feedback').html(json);
console.log("SUCCESS : ", data);
$("#btn-search").prop("disabled", false);
},
error: function (e) {
var json = "Ajax Response
"
+ e.responseText + "";
$('#feedback').html(json);
console.log("ERROR : ", e);
$("#btn-search").prop("disabled", false);
}
});
}
完成。
5.演示
5.1启动Spring Boot
终奌站
$ mvn spring-boot:run
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v1.5.1.RELEASE)
2017-02-03 14:56:36 DEBUG com.mkyong.SpringBootWebApplication - Running with Spring Boot v1.5.1.RELEASE, Spring v4.3.6.RELEASE
2017-02-03 14:56:36 INFO com.mkyong.SpringBootWebApplication - No active profile set, falling back to default profiles: default
2017-02-03 14:56:39 INFO com.mkyong.SpringBootWebApplication - Started SpringBootWebApplication in 2.828 seconds (JVM running for 3.295)
5.2访问http：// localhost：8080 /
5.3如果用户名为空！
5.4如果找不到用户名！
5.5如果找到用户名！
6.下载源代码
下载 - spring-boot-ajax-example.zip（10 KB）
参考
- Spring IO - 构建RESTful Web服务
- MDN - JSON.stringify（）
- Spring 4 MVC Ajax Hello World示例
关于作者
mkyong
Mkyong.com的 创始人，喜欢Java和开源的东西。在Twitter上关注他，或在Facebook或Google Plus上与他交朋友。如果您喜欢z这个的教程，请考虑向这些慈善机构捐款。[很赞]
本文翻译自:https://www.mkyong.com/spring-boot/spring-boot-ajax-example/