来源:
https://blog.csdn.net/saytime/article/details/74783294
个人其实偏向于使用类似于JdbcTemplate这种的框架,返回数据也习惯于接受Map/List形式,而不是转化成对象,一是前后台分离转成json方便,另外是返回数据格式,数据字段可以通过SQL控制,而不是返回整个对象字段数据,或者通过VO方式。当然更多人习惯于采用Bean形式,所以这里也同样使用Bean.
一、数据准备
数据库名:db_test
CREATE TABLE `tb_user` (
`id` int(11) NOT NULL AUTO_INCREMENT COMMENT ‘ID’,
`username` varchar(50) NOT NULL COMMENT ‘用户名’,
`age` int(11) NOT NULL COMMENT ‘年龄’,
`ctm` datetime NOT NULL COMMENT ‘创建时间’,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8
INSERT INTO `db_test`.`tb_user` (`username`, `age`, `ctm`) VALUES(‘张三’, ’18’, NOW()) ;
INSERT INTO `db_test`.`tb_user` (`username`, `age`, `ctm`) VALUES(‘李四’, ’20’, NOW()) ;
INSERT INTO `db_test`.`tb_user` (`username`, `age`, `ctm`) VALUES(‘王五’, ’19’, NOW()) ;
二、引入依赖
<!– jdbcTemplate –>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<!– MySQL连接 –>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
另外web依赖也需要,因为我们采用MVC模式。
<!– Add typical dependencies for a web application –>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
注意事项:pom.xml中引入依赖时有红色字体(注意本图与本讲实例无关,仅作示例)
出现这种情况,应该是ItelliJ 中maven 与setting.xml设置的问题
解决方案设置maven与setting.xml
例如InteliJ IDEA
file —> setting —->
点击ok之后,重新 update maven,操作方法是,右键点击pom.xml ——->maven ——> Reimport
或者根据IDEA的右下角的提示 import maven来更新。 更新有时候要一点时间哦!
此时项目正常运行。
三、数据库配置文件
一如既往,我们采用yml文件配置,当然properties文件也是一样。
注意点,SpringBoot默认采用tomcat-jdbc连接池,如果需要C3P0,DBCP,Druid等作为连接池,需要加入相关依赖以及配置,这里不作说明,采用默认配置即可。
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/db_user
username: root
password: root
四、代码
项目结构如下:
实体类User.class
package cn.saytime.bean;
import java.util.Date;
/**
* @ClassName cn.saytime.bean.User
* @Description
* @date 2017-07-04 22:47:28
*/
public class User
{
private int id;
private String username;
private int age;
private Date ctm;
public User() {
}
public User(String username, int age) {
this.username = username;
this.age = age;
this.ctm = new Date();
}
// Getter、Setter
}
——————————————-
UserDao.class
package cn.saytime.dao;
import cn.saytime.bean.User;
import java.util.List;
/**
* @ClassName cn.saytime.dao.UserDao
* @Description
* @date 2017-07-04 22:48:45
*/
public interface UserDao
{
User getUserById(Integer id);
public List<User> getUserList();
public int add(User user);
public int update(Integer id, User user);
public int delete(Integer id);
}
———————————–
注意在下面Dao的实现类
UserDaoImpl
上加了@Repository 注解,这个注解与Dao的区别是负责对象持久化的管理,而Dao直接负责数据的存取工作。Repository是相对对象而言,DAO则是相对数据库而言,虽然可能是同一个东西 ,但侧重点完全不同。
@Repository用于标注数据访问组件,
@Repository(value=”userDao”)注解是告诉Spring,让Spring创建一个名字叫“userDao”的UserDaoImpl实例。
这样设计的好处有两个:
- 降低层级之间的耦合:更换、升级ORM引擎(Hibernate)并不会影响业务逻辑
- 提高测试效率:如果在测试时能用Mock数据对象代替实际的数据库操作,运行速度会快很多
———————————–
IDEA上如何操作可以让接口的使用类自动加入接口的方法呢?
首先:IDEA上需要手动写 implements UserDao 这几个字才能让一个类使用接口;
其次:实现类上并不自动把接口的方法自动引入进来,此时必须手动加载;
方法是:用鼠标点击一下红波浪线提示的类名,注意一定要点一下,不是指着它,然后按
alt + 回车键,然后选择 Implement method
就可以单选,多选的加入了, 多选用 shilt + 鼠标 点击。
———————————–
UserDaoImpl.class
package cn.saytime.dao.impl;
import cn.saytime.bean.User;
import cn.saytime.dao.UserDao;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.BeanPropertyRowMapper;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Repository;
import java.util.Date;
import java.util.List;
/**
* @ClassName cn.saytime.dao.impl.UserDaoImpl
* @Description
* @date 2017-07-04 22:50:07
*/
@Repository
public class UserDaoImpl implements UserDao
{
@Autowired
private JdbcTemplate jdbcTemplate; //这个是系统自带的
@Override
public User getUserById(Integer id) {
List<User> list = jdbcTemplate.query(“select * from tb_user where id = ?”, new Object[]{id}, new BeanPropertyRowMapper(User.class));
if(list!=null && list.size()>0){
return list.get(0);
}else{
return null;
}
}
@Override
public List<User> getUserList() {
List<User> list = jdbcTemplate.query(“select * from tb_user”, new Object[]{}, new BeanPropertyRowMapper(User.class));
if(list!=null && list.size()>0){
return list;
}else{
return null;
}
}
@Override
public int add(User user) {
return jdbcTemplate.update(“insert into tb_user(username, age, ctm) values(?, ?, ?)”,
user.getUsername(),user.getAge(), new Date());
}
@Override
public int update(Integer id, User user) {
return jdbcTemplate.update(“UPDATE tb_user SET username = ? , age = ? WHERE id=?”,
user.getUsername(),user.getAge(), id);
}
@Override
public int delete(Integer id) {
return jdbcTemplate.update(“DELETE from tb_user where id = ? “,id);
}
}
—————————
UserService.class
package cn.saytime.service;
import cn.saytime.bean.User;
import org.springframework.stereotype.Service;
import java.util.List;
/**
* @ClassName cn.saytime.service.UserService
* @Description
* @date 2017-07-04 22:49:05
*/
public interface UserService
{
User getUserById(Integer id);
public List<User> getUserList();
public int add(User user);
public int update(Integer id, User user);
public int delete(Integer id);
}
—————————————-
UserServiceimpl.class
package cn.saytime.service.impl;
import cn.saytime.bean.User;
import cn.saytime.dao.UserDao;
import cn.saytime.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
/**
* @ClassName cn.saytime.service.impl.UserServiceImpl
* @Description
* @date 2017-07-04 22:49:27
*/
@Service
public class UserServiceImpl implements UserService
{
@Autowired
private UserDao userDao;
@Override
public User getUserById(Integer id) {
return userDao.getUserById(id);
}
@Override
public List<User> getUserList() {
return userDao.getUserList();
}
@Override
public int add(User user) {
return userDao.add(user);
}
@Override
public int update(Integer id, User user) {
return userDao.update(id, user);
}
@Override
public int delete(Integer id) {
return userDao.delete(id);
}
}
—————————————-
JsonResult.class 通用json返回类。
package cn.saytime.bean;
public class JsonResult
{
private String status = null; //返回的数据
private Object result = null; //返回的状态
public JsonResult status(String status) { //注意方法名是可以与属性名同名的。
this.status = status;
return this;
}
// Getter Setter
}
———————–
注意:下面的代码中使用了注解@PathVariable
它是从Url中拿数据,如果你是想从form表中拿数据,那么就用@RequestParam中拿数据。
在这个类中还使用了ResponseEntity, 它可以自定义返回HttpHeaders的内容和返回HttpStatus的状态
关于ResponseEntity的更多知识点,请看:
https://blog.csdn.net/neweastsun/article/details/81142870
与@ResponseBody的区别是,@ResponseBody可以直接返回结果;
———————–
UserController.class(Restful风格)
package cn.saytime.web;
import cn.saytime.bean.JsonResult;
import cn.saytime.bean.User;
import cn.saytime.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.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
/**
* @ClassName cn.saytime.web.UserController
* @Description
* @date 2017-07-04 22:46:14
*/
@RestController
public class UserController
{
@Autowired
private UserService userService;
/**
* 根据ID查询用户
* @param id
* @return
*/
@RequestMapping(value = “user/{id}”, method = RequestMethod.GET)
public ResponseEntity<JsonResult> getUserById (@PathVariable(value = “id”) Integer id){
JsonResult r = new JsonResult();
try {
User user = userService.getUserById(id);
r.setResult(user);
r.setStatus(“ok”);
} catch (Exception e) {
r.setResult(e.getClass().getName() + “:” + e.getMessage());
r.setStatus(“error”);
e.printStackTrace();
}
return ResponseEntity.ok(r);
}
/**
* 查询用户列表
* @return
*/
@RequestMapping(value = “users”, method = RequestMethod.GET)
public ResponseEntity<JsonResult> getUserList (){
JsonResult r = new JsonResult();
try {
List<User> users = userService.getUserList();
r.setResult(users);
r.setStatus(“ok”);
} catch (Exception e) {
r.setResult(e.getClass().getName() + “:” + e.getMessage());
r.setStatus(“error”);
e.printStackTrace();
}
return ResponseEntity.ok(r);
}
/**
* 添加用户
* @param user
* @return
* @requestBody注解常用来处理content-type不是默认的application/x-www-form-urlcoded编码的内容,
* 比如说:application/json或者是application/xml等。一般情况下来说常用其来处理application/json类型。
* 就是从json中提取数据 参见:
https://www.cnblogs.com/qiankun-site/p/5774300.html
*/
@RequestMapping(value = “user”, method = RequestMethod.POST)
public ResponseEntity<JsonResult> add (@RequestBody User user){
JsonResult r = new JsonResult();
try {
int orderId = userService.add(user);
if (orderId < 0) {
r.setResult(orderId);
r.setStatus(“fail”);
} else {
r.setResult(orderId);
r.setStatus(“ok”);
}
} catch (Exception e) {
r.setResult(e.getClass().getName() + “:” + e.getMessage());
r.setStatus(“error”);
e.printStackTrace();
}
return ResponseEntity.ok(r);
}
/**
* 根据id删除用户
* @param id
* @return
*/
@RequestMapping(value = “user/{id}”, method = RequestMethod.DELETE)
public ResponseEntity<JsonResult> delete (@PathVariable(value = “id”) Integer id){
JsonResult r = new JsonResult();
try {
int ret = userService.delete(id);
if (ret < 0) {
r.setResult(ret);
r.setStatus(“fail”);
} else {
r.setResult(ret);
r.setStatus(“ok”);
}
} catch (Exception e) {
r.setResult(e.getClass().getName() + “:” + e.getMessage());
r.setStatus(“error”);
e.printStackTrace();
}
return ResponseEntity.ok(r);
}
/**
* 根据id修改用户信息
* @param user
* @return
*/
@RequestMapping(value = “user/{id}”, method = RequestMethod.PUT)
public ResponseEntity<JsonResult> update (@PathVariable(“id”) Integer id, @RequestBody User user){
JsonResult r = new JsonResult();
try {
int ret = userService.update(id, user);
if (ret < 0) {
r.setResult(ret);
r.setStatus(“fail”);
} else {
r.setResult(ret);
r.setStatus(“ok”);
}
} catch (Exception e) {
r.setResult(e.getClass().getName() + “:” + e.getMessage());
r.setStatus(“error”);
e.printStackTrace();
}
return ResponseEntity.ok(r);
}
}
五、测试
测试时要下载chrom(谷哥浏览器)的postman这个插件使用更方便,下面就是用得这个插件。
启动postman后,选Request
其它知识点:
Collections:在Postman中,Collection类似文件夹,可以把同一个项目的请求放在一个Collection里方便管理和分享,Collection里面也可以再建文件夹。如果做API文档的话,可以每个API对应一条请求,如果要把各种输入都测到的话,就需要每条测试一条请求了。这里我新建了一个example用于介绍整个流程,五个API对应五条请求。这个Collection可以通过
GET
http://localhost:8080/users
获取用户列表
GET
http://localhost:8080/user/{id}
根据ID获取用户信息
POST
http://localhost:8080/user
添加用户(注意提交格式以及内容)
因为代码中使用@RequestBody注解接收postman请求参数,所以
按顺序1.2.3.4依次操作之后, Headers中会多出一条信息
但此时观看数据库中的数据时,赵六成了乱码。解决办法是配置文件中,“?”号及后面的都要加上。特别是utf-8编码。
spring: datasource: drive-class-name: com.mysql.jdbc.Driver url: jdbc:mysql://localhost:3306/springboot?autoReconnect=true&initialTimeout=3&useUnicode=true&characterEncoding=utf-8 username: root password: 650728061
PUT
http://localhost:8080/user/{id}
根据ID修改用户信息
再次查询所有用户信息
DELETE
http://localhost:8080/user/{id}
根据ID删除用户
最终用户数据
测试结果通过,ok