目录
获取在首页中显示的版块
1. 实现逻辑
2. 创建扩展 Mapper.xml
3. 修改 DAO
4. 创建 Service 接口
5. 实现 Service 接口
6. 生成测试方法
7. 实现 Controller
8. 实现前端页面
在数据库中执行以下 SQL 语句:
INSERT INTO `t_board` (`id`, `name`, `articleCount`, `sort`, `state`, `deleteState`, `createTime`, `updateTime`)
VALUES (1, 'Java', 0, 1, 0, 0, '2023-01-14 19:02:18', '2023-01-14 19:02:18');
INSERT INTO `t_board` (`id`, `name`, `articleCount`, `sort`, `state`, `deleteState`, `createTime`, `updateTime`)
VALUES (2, 'C++', 0, 2, 0, 0, '2023-01-14 19:02:41', '2023-01-14 19:02:41');
INSERT INTO `t_board` (`id`, `name`, `articleCount`, `sort`, `state`, `deleteState`, `createTime`, `updateTime`)
VALUES (3, '前端技术', 0, 3, 0, 0, '2023-01-14 19:02:52', '2023-01-14 19:02:52');
INSERT INTO `t_board` (`id`, `name`, `articleCount`, `sort`, `state`, `deleteState`, `createTime`, `updateTime`)
VALUES (4, 'MySQL', 0, 4, 0, 0, '2023-01-14 19:03:02', '2023-01-14 19:03:02');
INSERT INTO `t_board` (`id`, `name`, `articleCount`, `sort`, `state`, `deleteState`, `createTime`, `updateTime`)
VALUES (5, '⾯试宝典', 0, 5, 0, 0, '2023-01-14 19:03:24', '2023-01-14 19:03:24');
INSERT INTO `t_board` (`id`, `name`, `articleCount`, `sort`, `state`, `deleteState`, `createTime`, `updateTime`)
VALUES (6, '经验分享', 0, 6, 0, 0, '2023-01-14 19:03:48', '2023-01-14 19:03:48');
INSERT INTO `t_board` (`id`, `name`, `articleCount`, `sort`, `state`, `deleteState`, `createTime`, `updateTime`)
VALUES (7, '招聘信息', 0, 7, 0, 0, '2023-01-25 21:25:33', '2023-01-25 21:25:33');
INSERT INTO `t_board` (`id`, `name`, `articleCount`, `sort`, `state`, `deleteState`, `createTime`, `updateTime`)
VALUES (8, '福利待遇', 0, 8, 0, 0, '2023-01-25 21:25:58', '2023-01-25 21:25:58');
INSERT INTO `t_board` (`id`, `name`, `articleCount`, `sort`, `state`, `deleteState`, `createTime`, `updateTime`)
VALUES (9, '灌⽔区', 0, 9, 0, 0, '2023-01-25 21:26:12', '2023-01-25 21:26:12');
运行以上 SQL 语句后,表格中现有数据:
获取在首页中显示的版块
在首页显示的版块信息,可以通过以下两种方式解决:
- 方法一:单独提供查询前N条记录的接口,用来控制首页中版块的个数
- 方法二:通过配置表中 state 字段来实现,提供查询所有版块的接口
- 两种方式任选⼀个都可以,项目中使用方法一
1. 实现逻辑
- 用户访问首页
- 服务器查询有效的板块并按照排序字段排序 asc
- 返回板块集合
2. 创建扩展 Mapper.xml
在 mapper/extension 目录下 新建文件 BoardExtMapper.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.example.demo.dao.BoardMapper">
<!-- 查询首页的板块列表 -->
<select id="selectByNum" resultMap="BaseResultMap" parameterType="java.lang.Integer">
select
<include refid="Base_Column_List"/>
from t_board
where deleteState = 0 and state = 0
order by sort asc
limit #{num,jdbcType=INTEGER}
</select>
</mapper>
3. 修改 DAO
在 dao 包下的 BoardMapper 中添加方法声明:
/**
* 查询前 N个正常状态的版块
* @param num 查询的个数
* @return 前N个版块的集合
*/
List<Board> selectByNum (@Param("num") Integer num);
4. 创建 Service 接口
在 IBoradService 定义方法:
public interface IBoradService {
/**
* 查询首页的版块列表
* @param num 要查询的数据
* @return List<Board>
*/
List<Board> selectByNum (Integer num);
}
5. 实现 Service 接口
在 services.impl 包下新建 BoardServiceImpl 类:
@Slf4j
@Service
public class BoardServiceImpl implements IBoradService {
@Resource
private BoardMapper boardMapper;
@Override
public List<Board> selectByNum(Integer num) {
// 参数校验
if (num == null || num <= 0) {
// 打印日志
log.warn(ResultCode.FAILED_PARAMS_VALIDATE.toString());
// 抛出异常
throw new ApplicationException(AppResult.failed(ResultCode.FAILED_PARAMS_VALIDATE));
}
// 调⽤DAO层查询
List<Board> result = boardMapper.selectByNum(num);
// 返回结果
return result;
}
}
6. 生成测试方法
@SpringBootTest
class BoardServiceImplTest {
@Resource
private IBoradService boradService;
@Resource
private ObjectMapper objectMapper;
@Test
void selectByNum() throws JsonProcessingException {
List<Board> boards = boradService.selectByNum(9);
System.out.println(objectMapper.writeValueAsString(boards));
}
}
7. 实现 Controller
在 controller 包下新建 BoradController 类:
@Api(tags = "板块接口")
@Slf4j
@RestController
@RequestMapping("/board")
public class BoradController {
@Resource
private IBoradService boradService;
@ApiOperation("获取首页板块列表")
@GetMapping("/topList")
public AppResult<List<Board>> topList(){
// 调用 Service
List<Board> result = boradService.selectByNum(9);
// 返回结果
return AppResult.success(result);
}
}
9 这个数字,目前是以硬代码的方式固定在程序中,为了方便配置,还是希望把他放在配置文件中。
继续补充 BoradController 类:
@Slf4j
@SpringBootTest
class BoardServiceImplTest {
// 从配置文件中获取主页中显⽰的版块个数,默认为9
@Value("${bit-forum.index.board-num:9}")
private Integer indexBoardNum;
@Resource
private IBoradService boradService;
@Resource
private ObjectMapper objectMapper;
@Test
void selectByNum() throws JsonProcessingException {
log.debug("主页中显示的版块个数为:" + indexBoardNum);
List<Board> boards = boradService.selectByNum(indexBoardNum);
System.out.println(objectMapper.writeValueAsString(boards));
}
}
测试结果如下图所示:
8. 实现前端页面
$.ajax({
type: 'get',
url: 'board/topList',
// 成功回调
success: function(respData){
if(respData.code == 0){
// 成功
buildTopBoard(respData.data);
}else{
// 失败
$.toast({
heading : '警告',
text : respData.message,
icon : 'Warning'
});
}
},
// 失败回调
error: function(){
$.toast({
heading : '错误',
text : '出错了,请联系管理员',
icon : 'error'
});
}
});