Springboostweb案例(一)
准备工作
需求说明
- 需要完成以下功能:
部门管理 | 员工管理 |
---|---|
查询部门列表 | 查询员工列表(分页、条件) |
删除部门 | 删除员工 |
新增部门 | 新增员工 |
修改部门 | 修改员工 |
环境搭建
项目架构:
- 准备数据库表(dept、emp)。
-- 部门管理
create table dept(
id int unsigned primary key auto_increment comment '主键ID',
name varchar(10) not null unique comment '部门名称',
create_time datetime not null comment '创建时间',
update_time datetime not null comment '修改时间'
) comment '部门表';
insert into dept (id, name, create_time, update_time) values(1,'学工部',now(),now()),(2,'教研部',now(),now()),(3,'咨询部',now(),now()), (4,'就业部',now(),now()),(5,'人事部',now(),now());
-- 员工管理(带约束)
create table emp (
id int unsigned primary key auto_increment comment 'ID',
username varchar(20) not null unique comment '用户名',
password varchar(32) default '123456' comment '密码',
name varchar(10) not null comment '姓名',
gender tinyint unsigned not null comment '性别, 说明: 1 男, 2 女',
image varchar(300) comment '图像',
job tinyint unsigned comment '职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师',
entrydate date comment '入职时间',
dept_id int unsigned comment '部门ID',
create_time datetime not null comment '创建时间',
update_time datetime not null comment '修改时间'
) comment '员工表';
INSERT INTO emp
(id, username, password, name, gender, image, job, entrydate,dept_id, create_time, update_time) VALUES
(1,'jinyong','123456','金庸',1,'1.jpg',4,'2000-01-01',2,now(),now()),
(2,'zhangwuji','123456','张无忌',1,'2.jpg',2,'2015-01-01',2,now(),now()),
(3,'yangxiao','123456','杨逍',1,'3.jpg',2,'2008-05-01',2,now(),now()),
(4,'weiyixiao','123456','韦一笑',1,'4.jpg',2,'2007-01-01',2,now(),now()),
(5,'changyuchun','123456','常遇春',1,'5.jpg',2,'2012-12-05',2,now(),now()),
(6,'xiaozhao','123456','小昭',2,'6.jpg',3,'2013-09-05',1,now(),now()),
(7,'jixiaofu','123456','纪晓芙',2,'7.jpg',1,'2005-08-01',1,now(),now()),
(8,'zhouzhiruo','123456','周芷若',2,'8.jpg',1,'2014-11-09',1,now(),now()),
(9,'dingminjun','123456','丁敏君',2,'9.jpg',1,'2011-03-11',1,now(),now()),
(10,'zhaomin','123456','赵敏',2,'10.jpg',1,'2013-09-05',1,now(),now()),
(11,'luzhangke','123456','鹿杖客',1,'11.jpg',5,'2007-02-01',3,now(),now()),
(12,'hebiweng','123456','鹤笔翁',1,'12.jpg',5,'2008-08-18',3,now(),now()),
(13,'fangdongbai','123456','方东白',1,'13.jpg',5,'2012-11-01',3,now(),now()),
(14,'zhangsanfeng','123456','张三丰',1,'14.jpg',2,'2002-08-01',2,now(),now()),
(15,'yulianzhou','123456','俞莲舟',1,'15.jpg',2,'2011-05-01',2,now(),now()),
(16,'songyuanqiao','123456','宋远桥',1,'16.jpg',2,'2007-01-01',2,now(),now()),
(17,'chenyouliang','123456','陈友谅',1,'17.jpg',NULL,'2015-03-21',NULL,now(),now());
-
创建springboot工程,引入对应的起步依赖(web、mybatis、mysql驱动、lombok)。
-
配置文件application.properties中引入mybatis的配置信息,准备对应的实体类。
#驱动类名称
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#数据库连接的url
spring.datasource.url=jdbc:mysql://localhost:3306/example
#连接数据库的用户名
spring.datasource.username=root
#连接数据库的密码
spring.datasource.password=1234
#配置mybatis的日志, 指定输出到控制台
mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
#开启mybatis的驼峰命名自动映射开关 a_column ------> aColumn
mybatis.configuration.map-underscore-to-camel-case=true
- 准备对应的Mapper、Service(接口、实现类)、Controller基础结构。
开发规范
- 基于当前最为主流的前后端分离模式进行开发。
RESTful
- REST(REpresentational State Transfer),表述性状态转换,它是一种软件架构风格。
- 它使用URL定位资源,使用HTTP动词描述操作。
请求方式 | 对应操作 |
---|---|
GET | 查 |
POST | 增 |
DELETE | 删 |
PUT | 改 |
注意事项
- REST是风格,是约定方式,约定不是规定,可以打破。
- 描述模块的功能通常使用复数,也就是加s的格式来描述,表示此类资源,而非单个资源。
统一响应结果
- 前后端交互统一响应结果Result文件:
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result {
private Integer code;//响应码,1 代表成功; 0 代表失败
private String msg; //响应信息 描述字符串
private Object data; //返回的数据
public static Result success() { //增删改 成功响应
return new Result(1,"success",null);
}
public static Result success(Object data) { //查询 成功响应
return new Result(1,"success",data);
}
public static Result error(String msg) { //失败响应
return new Result(0,msg,null);
}
}
开发流程
查看页面原型,明确需求 → 阅读接口文档 → 思路分析 → 接口开发 → 接口测试 → 前后端联调
部门管理
查询全部部门
需求
查询全部数据(由于部门数据比较少,不考虑分页)。
思路
实现
- DeptController:
@Slf4j
@RestController
public class DeptController {
@Autowired
private DeptService deptService;
@GetMapping("/depts")
public Result list() {
log.info("查询全部部门数据");
List<Dept> deptList = deptService.list();
return Result.success(deptList);
}
}
- Result:
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result {
private Integer code;//响应码,1 代表成功; 0 代表失败
private String msg; //响应信息 描述字符串
private Object data; //返回的数据
//增删改 成功响应
public static Result success(){
return new Result(1,"success",null);
}
//查询 成功响应
public static Result success(Object data){
return new Result(1,"success",data);
}
//失败响应
public static Result error(String msg){
return new Result(0,msg,null);
}
}
- DeptService:
@Service
public interface DeptService {
/**
* 查询全部部门数据
* @return
*/
List<Dept> list();
}
- DeptServiceImpl:
@Service
public class DeptServiceImpl implements DeptService {
@Autowired
private DeptMapper deptMapper;
@Override
public List<Dept> list() {
return deptMapper.list();
}
}
- DeptMapper:
@Mapper
public interface DeptMapper {
/**
* 查询全部部门数据
* @return
*/
@Select("Select * from dept")
List<Dept> list();
}
接口测试
启动后端程序,使用postman发送请求进行调试。
前后端联调
将前后端程序都启动起来,然后打开网页进行调试。
小结
可以使用lombok类库提供的@Slf4j注解在被注解类中自动生成一个叫log的Logger对象。
删除部门
需求
根据id删除部门数据。
实现
- DeptController:
@DeleteMapping("/depts/{id}")
public Result delete(@PathVariable Integer id) {
log.info("根据id删除部门数据:{}", id);
deptService.delete(id);
return Result.success();
}
- DeptService:
void delete(Integer id);
- DeptServiceImpl:
@Override
public void delete(Integer id) {
deptMapper.deleteById(id);
}
- DeptMapper:
@Delete("delete from dept where id = #{id}")
void deleteById(Integer id);
新增部门
需求
根据输入的部门名新增部门数据。
实现
- DeptController:
@PostMapping("/depts")
public Result insert(@RequestBody Dept dept) {
log.info("添加部门:{}", dept);
deptService.insert(dept);
return Result.success();
}
- DeptService:
void insert(Dept dept);
- DeptServiceImpl:
@Override
public void insert(Dept dept) {
dept.setCreateTime(LocalDateTime.now());
dept.setUpdateTime(LocalDateTime.now());
deptMapper.insert(dept);
}
- DeptMapper:
@Insert("insert into dept(name, create_time, update_time) values(#{name}, #{createTime}, #{updateTime})")
void insert(Dept dept);
补充
- 可以将Controller类里共有的路径抽出到类上的@RequestMapping注解里。
- 一个完整的请求路径,应该是类上的@RequestMapping的value属性+方法上的@RequestMapping的value属性。
根据ID查询部门
需求
根据ID查询部门数据。
实现
- DeptController:
@GetMapping("/{id}")
public Result listById(@PathVariable Integer id) {
log.info("根据id查询部门数据:{}", id);
Dept dept = deptService.listById(id);
return Result.success(dept);
}
- DeptService:
Dept listById(Integer id);
- DeptServiceImpl:
@Override
public Dept listById(Integer id) {
return deptMapper.listById(id);
}
- DeptMapper:
@Select("select * from dept where id = #{id}")
Dept listById(Integer id);
修改部门
需求
修改部门数据的名称。
实现
- DeptController:
@PutMapping
public Result modify(@RequestBody Dept dept) {
log.info("根据id修改部门数据的名称:{}", dept);
deptService.modifyById(dept);
return Result.success();
}
- DeptService:
void modifyById(Dept dept);
- DeptServiceImpl:
@Override
public void modifyById(Dept dept) {
deptMapper.modifyById(dept);
}
- DeptMapper:
@Update("update dept set name = #{name} where id = #{id}")
void modifyById(Dept dept);
员工管理
分页查询
分析
- 请求参数:页码、每页展示记录数。
- 响应结果:总记录数、结果列表 (PageBean)。
需求
查询分页的员工数据。
思路
实现
- EmpController:
@Slf4j
@RestController
@RequestMapping("/emps")
public class EmpController {
@Autowired
private EmpService empService;
@GetMapping
public Result page(@RequestParam(defaultValue = "1") Integer page,
@RequestParam(defaultValue = "10") Integer pageSize) {
log.info("分页查询,参数:{},{}", page, pageSize);
PageBean pageBean = empService.page(page, pageSize);
return Result.success(pageBean);
}
}
//注意:@RequestParam(defaultValue="1")用于设置请求参数默认值
- EmpService:
public interface EmpService {
PageBean page(Integer page, Integer pageSize);
}
- EmpServiceImpl:
@Service
public class EmpServiceImpl implements EmpService {
@Autowired
private EmpMapper empMapper;
@Override
public PageBean page(Integer page, Integer pageSize) {
Long count = empMapper.count();
Integer start = (page - 1) * pageSize;
List<Emp> empList = empMapper.page(start, pageSize);
PageBean pageBean = new PageBean(count, empList);
return pageBean;
}
}
- EmpMapper:
@Mapper
public interface EmpMapper {
@Select("select count(*) from emp")
Long count();
@Select("select * from emp limit #{start}, #{pageSize}")
List<Emp> page(@Param("start") Integer start, @Param("pageSize") Integer pageSize);
}
PageHelper分页插件
使用步骤:
- 引入依赖:
<!--pom.xml-->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.4.2</version>
</dependency>
- 使用:
//EmpMapper
@Select("select * from emp")
List<Emp> list();
//EmpServiceImpl
@Override
public PageBean page(Integer page, Integer pageSize) {
//1.设置分页参数
PageHelper.startPage(page, pageSize);
//2.执行查询
List<Emp> empList = empMapper.list();
Page<Emp> p = (Page<Emp>) empList;
//3.封装PageBean对象
PageBean pageBean = new PageBean(p.getTotal(), p.getResult());
return pageBean;
}
分页查询(带条件)
实现
- EmpController:
@GetMapping
public Result page(String name, Short gender,
@DateTimeFormat(pattern = "yyyy-MM-dd") LocalDateTime begin,
@DateTimeFormat(pattern = "yyyy-MM-dd") LocalDateTime end,
@RequestParam(defaultValue = "1") Integer page,
@RequestParam(defaultValue = "10") Integer pageSize) {
log.info("分页查询,参数:{},{}, {}, {}, {}, {}", name, gender, begin, end, page, pageSize);
PageBean pageBean = empService.page(name, gender, begin, end, page, pageSize);
return Result.success(pageBean);
}
- EmpService:
PageBean page(String name, Short gender, LocalDateTime begin, LocalDateTime end, Integer page, Integer pageSize);
- EmpServiceImpl:
@Override
public PageBean page(String name, Short gender, LocalDateTime begin, LocalDateTime end,
Integer page, Integer pageSize) {
//1.设置分页参数
PageHelper.startPage(page, pageSize);
//2.执行查询
List<Emp> empList = empMapper.list(name, gender, begin, end);
Page<Emp> p = (Page<Emp>) empList;
//3.封装PageBean对象
PageBean pageBean = new PageBean(p.getTotal(), p.getResult());
return pageBean;
}
- EmpMapper:
List<Emp> list(@Param("name") String name, @Param("gender") Short gender,
@Param("begin") LocalDateTime begin, @Param("end") LocalDateTime end);
- EmpMapper.xml:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.zgg1h.mapper.EmpMapper">
<select id="list" resultType="com.zgg1h.pojo.Emp">
select * from emp
<where>
<if test="name != null and name != ''">
name like concat('%', #{name}, '%')
</if>
<if test="gender != null">
and gender = #{gender}
</if>
<if test="begin != null and end != null">
and entrydate between #{begin} and {end}
</if>
</where>
order by update_time desc
</select>
</mapper>
删除员工
实现
- EmpController:
@DeleteMapping("/{ids}")
public Result delete(@PathVariable List<Integer> ids) {
log.info("批量删除操作,ids:{}", ids);
empService.delete(ids);
return Result.success();
}
- EmpService:
void delete(List<Integer> ids);
- EmpServiceImpl:
@Override
public void delete(List<Integer> ids) {
empMapper.delete(ids);
}
- EmpMapper:
void delete(@Param("ids") List<Integer> ids);
- EmpMapper.xml:
<delete id="delete">
delete from emp where id in
<foreach collection="ids" item="id" open="(" separator="," close=")">
#{id}
</foreach>
</delete>
标签:第十天,笔记,public,dept,Result,Integer,now,id,JavaWeb
From: https://www.cnblogs.com/zgg1h/p/18106726