diff --git a/minsu/.idea/misc.xml b/minsu/.idea/misc.xml index 639900d1..a818314f 100644 --- a/minsu/.idea/misc.xml +++ b/minsu/.idea/misc.xml @@ -1,6 +1,6 @@ - + \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/controller/ForumController.java b/minsu/minsuguanliw/src/main/java/com/controller/ForumController.java index 0c7a52b7..25318035 100644 --- a/minsu/minsuguanliw/src/main/java/com/controller/ForumController.java +++ b/minsu/minsuguanliw/src/main/java/com/controller/ForumController.java @@ -1,4 +1,3 @@ - package com.controller; import java.io.File; @@ -35,315 +34,305 @@ import com.alibaba.fastjson.*; /** * 论坛 * 后端接口 - * @author + * 该类主要作为论坛相关功能的控制层，处理各种与论坛业务相关的HTTP请求，调用对应的服务层方法来实现具体功能， + * 并与数据库进行交互以及处理返回结果等操作。 + * @author WMZ * @email -*/ + */ @RestController @Controller @RequestMapping("/forum") public class ForumController { + // 创建日志记录器， + // 用于记录该类中各个方法执行过程中的关键信息，方便调试和问题排查 private static final Logger logger = LoggerFactory.getLogger(ForumController.class); + // 通过Spring的依赖注入，自动装配ForumService， + // 用于处理论坛相关的业务逻辑，比如查询、插入、更新、删除等操作 @Autowired private ForumService forumService; - + // 自动注入TokenService， + // 可能用于处理用户认证相关的令牌操作（具体功能需看对应服务层实现） @Autowired private TokenService tokenService; + // 自动注入DictionaryService， + // 用于处理字典表相关的数据转换等操作（比如将字典表中的编码转换为对应的有意义的值等） @Autowired private DictionaryService dictionaryService; - //级联表service + // 自动注入YonghuService， + // 用于处理与用户（Yonghu，可能是具体业务中的一种用户类型）相关的级联表操作 @Autowired private YonghuService yonghuService; + // 自动注入UsersService， + // 用于处理与普通用户相关的级联表操作（比如获取用户详细信息等） @Autowired private UsersService usersService; - - /** - * 后端列表 - */ + * 后端列表功能方法 + * 接收前端传来的查询参数params以及HttpServletRequest对象，用于获取分页数据以及进行相关业务逻辑处理， + * 根据参数查询论坛信息列表，并进行字典表数据转换后返回给前端。 + * @param params 包含查询条件、分页等相关参数的Map集合 + * @param request HttpServletRequest对象，用于获取请求相关的信息（如会话中的属性等） + * @return R类型的结果对象，包含操作结果状态以及查询到的数据等信息（R应该是自定义的统一返回结果类型） + */ @RequestMapping("/page") - public R page(@RequestParam Map params, HttpServletRequest request){ - logger.debug("page方法:,,Controller:{},,params:{}",this.getClass().getName(),JSONObject.toJSONString(params)); - if(params.get("orderBy")==null || params.get("orderBy")==""){ - params.put("orderBy","id"); + public R page(@RequestParam Map params, HttpServletRequest request) { + // 记录page方法的调用信息， + // 包括当前类名和传入的参数， + // 方便调试查看参数情况（以JSON字符串形式记录参数） + logger.debug("page方法:,,Controller:{},,params:{}", this.getClass().getName(), JSONObject.toJSONString(params)); + // 如果传入的排序字段参数为空， + // 则默认按照"id"字段进行排序 + if (params.get("orderBy") == null || params.get("orderBy") == "") { + params.put("orderBy", "id"); } + // 调用forumService的queryPage方法， + // 根据传入的参数获取分页数据（该方法内部应该是与数据库交互获取相应的数据列表等） PageUtils page = forumService.queryPage(params); - //字典表数据转换 - List list =(List)page.getList(); - for(ForumView c:list){ - //修改对应字典表字段 + // 获取分页数据中的列表数据 + // （这里应该是ForumView类型的列表，ForumView可能是用于展示的视图对象） + List list = (List) page.getList(); + // 遍历列表数据， + // 对每条数据进行字典表数据转换操作（比如将字典表中的编码转换为对应的实际含义显示给前端） + for (ForumView c : list) { dictionaryService.dictionaryConvert(c, request); } + // 返回包含处理后数据的成功结果对象 + // （R.ok()表示操作成功，并将数据放入返回对象中返回给前端） return R.ok().put("data", page); } /** - * 后端详情 - */ + * 后端详情功能方法 + * 根据传入的论坛记录id，从数据库中查询对应的论坛详细信息， + * 进行相关的实体转视图、级联表数据处理以及字典表数据转换后返回给前端。 + * @param id 要查询的论坛记录的唯一标识（Long类型的id） + * @param request HttpServletRequest对象， + * 用于获取请求相关的信息（如会话中的属性等） + * @return R类型的结果对象， + * 包含操作结果状态以及查询到的详细数据等信息（若查询到数据则返回成功及数据，否则返回错误提示） + */ @RequestMapping("/info/{id}") - public R info(@PathVariable("id") Long id, HttpServletRequest request){ - logger.debug("info方法:,,Controller:{},,id:{}",this.getClass().getName(),id); + public R info(@PathVariable("id") Long id, HttpServletRequest request) { + logger.debug("info方法:,,Controller:{},,id:{}", this.getClass().getName(), id); + // 通过forumService根据传入的id从数据库中查询对应的ForumEntity对象（ForumEntity可能是数据库对应的实体类） ForumEntity forum = forumService.selectById(id); - if(forum !=null){ - //entity转view + if (forum!= null) { + // 创建ForumView对象， + // 用于将查询到的实体数据转换为适合展示的视图数据（ForumView可能包含了部分需要展示给前端的字段等） ForumView view = new ForumView(); - BeanUtils.copyProperties( forum , view );//把实体数据重构到view中 - - //级联表 - YonghuEntity yonghu = yonghuService.selectById(forum.getYonghuId()); - if(yonghu != null){ - BeanUtils.copyProperties( yonghu , view ,new String[]{ "id", "createTime", "insertTime", "updateTime"});//把级联的数据添加到view中,并排除id和创建时间字段 - view.setYonghuId(yonghu.getId()); - } - //管理员用户表做特殊处理,防止和用户表账户姓名字段冲突 - UsersEntity users = usersService.selectById(forum.getUsersId()); - if(users != null){ - view.setUsersId(users.getId()); - view.setUusername(users.getUsername()); - view.setUpassword(users.getPassword()); - view.setUrole(users.getRole()); - view.setUaddtime(users.getAddtime()); - } - //修改对应字典表字段 + // 使用Spring的BeanUtils工具， + // 将forum实体对象中的属性值复制到view视图对象中 + BeanUtils.copyProperties(forum, view); + + // 处理级联表数据， + // 获取与该论坛记录关联的YonghuEntity（用户相关的实体对象），并将部分属性复制到view中（排除一些不需要的字段） + YonghuEntity yonghu = yonghuService.selectById(forum.getYonghuId()); + if (yonghu!= null) { + BeanUtils.copyProperties(yonghu, view, new String[] { "id", "createTime", "insertTime", "updateTime" }); + view.setYonghuId(yonghu.getId()); + } + // 处理管理员用户表数据， + // 获取与该论坛记录关联的UsersEntity（管理员用户相关的实体对象），并将部分关键属性设置到view中 + UsersEntity users = usersService.selectById(forum.getUsersId()); + if (users!= null) { + view.setUsersId(users.getId()); + view.setUusername(users.getUsername()); + view.setUpassword(users.getPassword()); + view.setUrole(users.getRole()); + view.setUaddtime(users.getAddtime()); + } + // 对view视图对象进行字典表数据转换操作 + // （比如将字典表中的编码转换为对应的实际含义显示给前端） dictionaryService.dictionaryConvert(view, request); + // 返回包含处理后详细数据的成功结果对象（R.ok()表示操作成功， + // 并将数据放入返回对象中返回给前端） return R.ok().put("data", view); - }else { - return R.error(511,"查不到数据"); + } else { + // 如果未查询到对应的数据， + // 则返回包含错误码和错误提示信息的错误结果对象 + return R.error(511, "查不到数据"); } - } /** - * 后端保存 - */ + * 后端保存功能方法 + * 接收前端传来的ForumEntity对象（包含要保存的论坛相关数据）以及HttpServletRequest对象， + * 根据当前用户角色设置相关的关联用户id，并检查数据是否重复后将数据插入到数据库中。 + * @param forum 包含要保存的论坛相关数据的ForumEntity对象 + * @param request HttpServletRequest对象，用于获取请求相关的信息（如会话中的用户角色、用户id等属性） + * @return R类型的结果对象，包含操作结果状态（成功或失败及对应的提示信息） + */ @RequestMapping("/save") - public R save(@RequestBody ForumEntity forum, HttpServletRequest request){ - logger.debug("save方法:,,Controller:{},,forum:{}",this.getClass().getName(),forum.toString()); + public R save(@RequestBody ForumEntity forum, HttpServletRequest request) { + logger.debug("save方法:,,Controller:{},,forum:{}", this.getClass().getName(), forum.toString()); + // 从HttpServletRequest的会话中获取当前用户的角色信息（这里先将获取到的Object类型强制转换为String类型） String role = String.valueOf(request.getSession().getAttribute("role")); - if(false) - return R.error(511,"永远不会进入"); - else if("用户".equals(role)) + if (false) + return R.error(511, "永远不会进入"); + else if ("用户".equals(role)) + // 如果当前用户角色是"用户"， + // 则将论坛记录的YonghuId设置为从会话中获取的当前用户的id（这里做了一些类型转换操作） forum.setYonghuId(Integer.valueOf(String.valueOf(request.getSession().getAttribute("userId")))); - else if("管理员".equals(role)) + else if ("管理员".equals(role)) + // 如果当前用户角色是"管理员"， + // 则将论坛记录的UsersId设置为从会话中获取的当前用户的id（同样进行了类型转换） forum.setUsersId(Integer.valueOf(String.valueOf(request.getSession().getAttribute("userId")))); + // 创建EntityWrapper对象， + // 用于构建查询条件，检查数据库中是否已经存在相同的数据（根据多个字段进行等值判断） Wrapper queryWrapper = new EntityWrapper() - .eq("forum_name", forum.getForumName()) - .eq("yonghu_id", forum.getYonghuId()) - .eq("users_id", forum.getUsersId()) - .eq("super_ids", forum.getSuperIds()) - .eq("forum_state_types", forum.getForumStateTypes()) - ; - - logger.info("sql语句:"+queryWrapper.getSqlSegment()); + .eq("forum_name", forum.getForumName()) + .eq("yonghu_id", forum.getYonghuId()) + .eq("users_id", forum.getUsersId()) + .eq("super_ids", forum.getSuperIds()) + .eq("forum_state_types", forum.getForumStateTypes()); + + logger.info("sql语句:" + queryWrapper.getSqlSegment()); + // 根据构建的查询条件查询数据库中是否已经存在相同的数据 + // （通过selectOne方法查询一条符合条件的数据） ForumEntity forumEntity = forumService.selectOne(queryWrapper); - if(forumEntity==null){ + if (forumEntity == null) { + // 如果不存在相同数据， + // 则设置论坛记录的插入时间和创建时间为当前时间，并将该记录插入到数据库中（通过insert方法） forum.setInsertTime(new Date()); forum.setCreateTime(new Date()); forumService.insert(forum); return R.ok(); - }else { - return R.error(511,"表中有相同数据"); + } else { + // 如果存在相同数据， + // 则返回包含错误码和提示信息的错误结果对象，表示表中已有相同数据 + return R.error(511, "表中有相同数据"); } } /** - * 后端修改 - */ + * 后端修改功能方法 + * 接收前端传来的ForumEntity对象（包含要修改的论坛相关数据）以及HttpServletRequest对象， + * 根据字段查询是否有相同数据，若不存在则根据id更新数据库中的对应论坛记录。 + * @param forum 包含要修改的论坛相关数据的ForumEntity对象 + * @param request HttpServletRequest对象，用于获取请求相关的信息（如会话中的用户角色等属性） + * @return R类型的结果对象，包含操作结果状态（成功或失败及对应的提示信息） + */ @RequestMapping("/update") - public R update(@RequestBody ForumEntity forum, HttpServletRequest request){ - logger.debug("update方法:,,Controller:{},,forum:{}",this.getClass().getName(),forum.toString()); + public R update(@RequestBody ForumEntity forum, HttpServletRequest request) { + logger.debug("update方法:,,Controller:{},,forum:{}", this.getClass().getName(), forum.toString()); String role = String.valueOf(request.getSession().getAttribute("role")); -// if(false) -// return R.error(511,"永远不会进入"); -// else if("用户".equals(role)) + + + + +// if (false) +// return R.error(511, "永远不会进入"); +// else if ("用户".equals(role)) // forum.setYonghuId(Integer.valueOf(String.valueOf(request.getSession().getAttribute("userId")))); -// else if("管理员".equals(role)) +// else if ("管理员".equals(role)) // forum.setUsersId(Integer.valueOf(String.valueOf(request.getSession().getAttribute("userId")))); - //根据字段查询是否有相同数据 + // 创建EntityWrapper对象，用于构建查询条件，检查数据库中除了当前要修改的记录（根据id排除）外是否存在相同的数据（根据多个字段进行等值判断） + Wrapper queryWrapper = new EntityWrapper() - .notIn("id",forum.getId()) - .andNew() - .eq("forum_name", forum.getForumName()) - .eq("yonghu_id", forum.getYonghuId()) - .eq("users_id", forum.getUsersId()) - .eq("super_ids", forum.getSuperIds()) - .eq("forum_state_types", forum.getForumStateTypes()) - ; - - logger.info("sql语句:"+queryWrapper.getSqlSegment()); + .notIn("id", forum.getId()) + .andNew() + .eq("forum_name", forum.getForumName()) + .eq("yonghu_id", forum.getYonghuId()) + .eq("users_id", forum.getUsersId()) + .eq("super_ids", forum.getSuperIds()) + .eq("forum_state_types", forum.getForumStateTypes()); + + + logger.info("sql语句:" + queryWrapper.getSqlSegment()); + // 根据构建的查询条件查询数据库中是否已经存在相同的数据（通过selectOne方法查询一条符合条件的数据） + ForumEntity forumEntity = forumService.selectOne(queryWrapper); + // 设置论坛记录的更新时间为当前时间 + + + forum.setUpdateTime(new Date()); - if(forumEntity==null){ - forumService.updateById(forum);//根据id更新 + if (forumEntity == null) { + // 如果不存在相同数据， + // 则根据传入的forum对象的id更新数据库中的对应论坛记录（通过updateById方法） + forumService.updateById(forum); return R.ok(); - }else { - return R.error(511,"表中有相同数据"); + } else { + // 如果存在相同数据， + // 则返回包含错误码和提示信息的错误结果对象，表示表中已有相同数据 + return R.error(511, "表中有相同数据"); } } - /** - * 删除 - */ + /** + * 删除功能方法 + * 接收前端传来的要删除的论坛记录的id数组，调用forumService的批量删除方法，从数据库中删除对应的数据记录， + * 并返回操作结果给前端。 + * @param ids 包含要删除的论坛记录的id的整数数组 + * @return R类型的结果对象，包含操作结果状态（成功或失败及对应的提示信息） + */ @RequestMapping("/delete") - public R delete(@RequestBody Integer[] ids){ - logger.debug("delete:,,Controller:{},,ids:{}",this.getClass().getName(),ids.toString()); + + + public R delete(@RequestBody Integer[] ids) { + logger.debug("delete:,,Controller:{},,ids:{}", this.getClass().getName(), ids.toString()); + // 调用forumService的deleteBatchIds方法， + // 批量删除数据库中对应id的论坛记录（传入的是将数组转换为List后的集合） forumService.deleteBatchIds(Arrays.asList(ids)); return R.ok(); } - /** - * 批量上传 + * 批量上传功能方法 + * 接收文件名fileName以及HttpServletRequest对象，用于将指定的Excel文件中的论坛数据批量插入到数据库中， + * 在插入前进行一些文件格式校验、数据读取以及重复数据检查等操作。 + * @param fileName 要上传的文件的名称（这里应该是位于特定目录下的文件名） + * @param request HttpServletRequest对象，用于获取请求相关的信息（如当前用户的id等属性） + * @return R类型的结果对象，包含操作结果状态（成功或失败及对应的提示信息） */ + + @RequestMapping("/batchInsert") - public R save( String fileName, HttpServletRequest request){ - logger.debug("batchInsert方法:,,Controller:{},,fileName:{}",this.getClass().getName(),fileName); + public R save(String fileName, HttpServletRequest request) { + logger.debug("batchInsert方法:,,Controller:{},,fileName:{}", this.getClass().getName(), fileName); + // 从HttpServletRequest的会话中获取当前用户的id，并转换为Integer类型（这里做了一些强制类型转换操作） Integer yonghuId = Integer.valueOf(String.valueOf(request.getSession().getAttribute("userId"))); SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); try { - List forumList = new ArrayList<>();//上传的东西 - Map> seachFields= new HashMap<>();//要查询的字段 + // 创建一个用于存储要插入数据库的ForumEntity对象列表（即从文件中读取到的多条论坛数据记录） + List forumList = new ArrayList<>(); + // 创建一个Map，用于存储要查询是否重复的字段信息（具体的使用方式需看后续代码逻辑） + Map> seachFields = new HashMap<>(); Date date = new Date(); int lastIndexOf = fileName.lastIndexOf("."); - if(lastIndexOf == -1){ - return R.error(511,"该文件没有后缀"); - }else{ + if (lastIndexOf == -1) { + return R.error(511, "该文件没有后缀"); + } else { String suffix = fileName.substring(lastIndexOf); - if(!".xls".equals(suffix)){ - return R.error(511,"只支持后缀为xls的excel文件"); - }else{ - URL resource = this.getClass().getClassLoader().getResource("static/upload/" + fileName);//获取文件路径 + if (!".xls".equals(suffix)) { + return R.error(511, "只支持后缀为xls的excel文件"); + } else { + // 通过类加载器获取指定文件名对应的文件资源路径（这里应该是位于"static/upload/"目录下的文件） + URL resource = this.getClass().getClassLoader().getResource("static/upload/" + fileName); File file = new File(resource.getFile()); - if(!file.exists()){ - return R.error(511,"找不到上传文件，请联系管理员"); - }else{ - List> dataList = PoiUtil.poiImport(file.getPath());//读取xls文件 - dataList.remove(0);//删除第一行，因为第一行是提示 - for(List data:dataList){ - //循环 + if (!file.exists()) { + return R.error(511, "找不到上传文件，请联系管理员"); + } else { + // 调用PoiUtil的poiImport方法读取Excel文件中的数据（返回的是一个嵌套的List，外层List表示行，内层List表示每行中的单元格数据） + List> dataList = PoiUtil.poiImport(file.getPath()); + // 删除读取到的数据列表中的第一行（可能是表头之类的提示信息，不需要插入数据库） + dataList.remove(0); + for (List data : dataList) { + // 循环处理每一行数据，创建一个ForumEntity对象，用于存储要插入数据库的一条论坛记录信息 ForumEntity forumEntity = new ForumEntity(); // forumEntity.setForumName(data.get(0)); //帖子标题 要改的 // forumEntity.setYonghuId(Integer.valueOf(data.get(0))); //用户 要改的 // forumEntity.setUsersId(Integer.valueOf(data.get(0))); //管理员 要改的 // forumEntity.setForumContent("");//详情和图片 // forumEntity.setSuperIds(Integer.valueOf(data.get(0))); //父id 要改的 -// forumEntity.setForumStateTypes(Integer.valueOf(data.get(0))); //帖子状态 要改的 -// forumEntity.setInsertTime(date);//时间 -// forumEntity.setUpdateTime(sdf.parse(data.get(0))); //修改时间 要改的 -// forumEntity.setCreateTime(date);//时间 - forumList.add(forumEntity); - - - //把要查询是否重复的字段放入map中 - } - - //查询是否重复 - forumService.insertBatch(forumList); - return R.ok(); - } - } - } - }catch (Exception e){ - e.printStackTrace(); - return R.error(511,"批量插入数据异常，请联系管理员"); - } - } - - - - - - /** - * 前端列表 - */ - @IgnoreAuth - @RequestMapping("/list") - public R list(@RequestParam Map params, HttpServletRequest request){ - logger.debug("list方法:,,Controller:{},,params:{}",this.getClass().getName(),JSONObject.toJSONString(params)); - - // 没有指定排序字段就默认id倒序 - if(StringUtil.isEmpty(String.valueOf(params.get("orderBy")))){ - params.put("orderBy","id"); - } - PageUtils page = forumService.queryPage(params); - - //字典表数据转换 - List list =(List)page.getList(); - for(ForumView c:list) - dictionaryService.dictionaryConvert(c, request); //修改对应字典表字段 - return R.ok().put("data", page); - } - - /** - * 前端详情 - */ - @RequestMapping("/detail/{id}") - public R detail(@PathVariable("id") Long id, HttpServletRequest request){ - logger.debug("detail方法:,,Controller:{},,id:{}",this.getClass().getName(),id); - ForumEntity forum = forumService.selectById(id); - if(forum !=null){ - - - //entity转view - ForumView view = new ForumView(); - BeanUtils.copyProperties( forum , view );//把实体数据重构到view中 - - //级联表 - YonghuEntity yonghu = yonghuService.selectById(forum.getYonghuId()); - if(yonghu != null){ - BeanUtils.copyProperties( yonghu , view ,new String[]{ "id", "createDate"});//把级联的数据添加到view中,并排除id和创建时间字段 - view.setYonghuId(yonghu.getId()); - } - UsersEntity users = usersService.selectById(forum.getUsersId()); - if(users != null){ - view.setUsersId(users.getId()); - view.setUusername(users.getUsername()); - view.setUpassword(users.getPassword()); - view.setUrole(users.getRole()); - view.setUaddtime(users.getAddtime()); - } - //修改对应字典表字段 - dictionaryService.dictionaryConvert(view, request); - return R.ok().put("data", view); - }else { - return R.error(511,"查不到数据"); - } - } - - - /** - * 前端保存 - */ - @RequestMapping("/add") - public R add(@RequestBody ForumEntity forum, HttpServletRequest request){ - logger.debug("add方法:,,Controller:{},,forum:{}",this.getClass().getName(),forum.toString()); - Wrapper queryWrapper = new EntityWrapper() - .eq("forum_name", forum.getForumName()) - .eq("yonghu_id", forum.getYonghuId()) - .eq("users_id", forum.getUsersId()) - .eq("super_ids", forum.getSuperIds()) - .eq("forum_state_types", forum.getForumStateTypes()) - ; - logger.info("sql语句:"+queryWrapper.getSqlSegment()); - ForumEntity forumEntity = forumService.selectOne(queryWrapper); - if(forumEntity==null){ - forum.setInsertTime(new Date()); - forum.setCreateTime(new Date()); - forumService.insert(forum); - return R.ok(); - }else { - return R.error(511,"表中有相同数据"); - } - } - - -} +// forumEntity.setForumStateTypes(Integer.valueOf(data.get(0))); //帖子状态 要改的 \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/controller/NewsController.java b/minsu/minsuguanliw/src/main/java/com/controller/NewsController.java index 65d2eeeb..d0e4feeb 100644 --- a/minsu/minsuguanliw/src/main/java/com/controller/NewsController.java +++ b/minsu/minsuguanliw/src/main/java/com/controller/NewsController.java @@ -1,4 +1,3 @@ - package com.controller; import java.io.File; @@ -35,178 +34,273 @@ import com.alibaba.fastjson.*; /** * 公告信息 * 后端接口 - * @author - * @email -*/ + * 该类作为公告信息相关功能的控制层，负责接收前端发送的各种HTTP请求， + * 调用对应的服务层方法来处理公告信息的查询、保存、修改、删除以及批量上传等业务操作， + * 并与数据库进行交互，对返回结果进行相应处理后返回给前端。 + * @author wangmuzi + * + */ @RestController @Controller @RequestMapping("/news") public class NewsController { + // 创建一个日志记录器，用于记录该类中各个方法执行过程中的关键信息，方便后续调试和问题排查 private static final Logger logger = LoggerFactory.getLogger(NewsController.class); + // 通过Spring的依赖注入， + // 自动装配NewsService，用于处理公告信息相关的核心业务逻辑，比如数据库操作等 @Autowired private NewsService newsService; - + // 自动注入TokenService， + // 可能用于处理与用户认证令牌相关的操作（具体功能需看对应服务层实现） @Autowired private TokenService tokenService; + // 自动注入DictionaryService， + // 用于处理字典表数据的转换操作，例如将字典表中的编码转换为有实际意义的展示值 @Autowired private DictionaryService dictionaryService; - //级联表service - + // 自动注入YonghuService， + // 可能用于处理与用户（Yonghu，可能是特定业务中的一种用户类型）相关的级联表操作（具体使用场景看后续代码逻辑） @Autowired private YonghuService yonghuService; - /** - * 后端列表 - */ + * 后端列表功能方法 + * 接收前端传来的查询参数以及HttpServletRequest对象，根据用户角色添加相应查询条件，获取公告信息的分页列表数据， + * 并对字典表相关字段进行数据转换后返回给前端。 + * @param params 包含查询条件、分页等相关参数的Map集合，例如每页显示数量、页码、排序字段等 + * @param request HttpServletRequest对象，用于获取请求相关的信息，如当前用户的角色、用户ID等，以便添加特定的查询条件 + * @return R类型的结果对象，包含操作结果状态以及查询到的分页数据等信息（R应该是自定义的统一返回结果类型） + */ @RequestMapping("/page") - public R page(@RequestParam Map params, HttpServletRequest request){ - logger.debug("page方法:,,Controller:{},,params:{}",this.getClass().getName(),JSONObject.toJSONString(params)); + public R page(@RequestParam Map params, HttpServletRequest request) { + // 记录page方法的调用信息， + // 包括当前类名和传入的参数（将参数转换为JSON字符串形式记录，方便查看参数详情），用于调试目的 + logger.debug("page方法:,,Controller:{},,params:{}", this.getClass().getName(), JSONObject.toJSONString(params)); + // 从HttpServletRequest的会话中获取当前用户的角色信息， + // 并转换为String类型 String role = String.valueOf(request.getSession().getAttribute("role")); - if(false) - return R.error(511,"永不会进入"); - else if("用户".equals(role)) - params.put("yonghuId",request.getSession().getAttribute("userId")); - if(params.get("orderBy")==null || params.get("orderBy")==""){ - params.put("orderBy","id"); + if (false) + return R.error(511, "永不会进入"); + else if ("用户".equals(role)) + // 如果当前用户角色是"用户"， + // 则将当前用户的ID添加到查询参数中，作为查询属于该用户的公告信息的条件（这里假设数据库中有对应的关联字段） + params.put("yonghuId", request.getSession().getAttribute("userId")); + // 如果传入的排序字段参数为空，则默认按照"id"字段进行排序 + if (params.get("orderBy") == null || params.get("orderBy") == "") { + params.put("orderBy", "id"); } + // 调用newsService的queryPage方法， + // 根据传入的参数获取公告信息的分页数据（该方法内部应该是与数据库交互来查询相应的数据列表等） PageUtils page = newsService.queryPage(params); - //字典表数据转换 - List list =(List)page.getList(); - for(NewsView c:list){ - //修改对应字典表字段 + // 获取分页数据中的列表数据（这里应该是NewsView类型的列表，NewsView可能是用于展示的视图对象） + List list = (List) page.getList(); + // 遍历列表数据，对每条数据进行字典表数据转换操作， + // 将字典表中的编码等转换为对应的实际展示值（比如状态码转换为具体的状态文字描述） + for (NewsView c : list) { dictionaryService.dictionaryConvert(c, request); } + // 返回包含处理后数据的成功结果对象（R.ok()表示操作成功， + // 并将数据放入返回对象中返回给前端） return R.ok().put("data", page); } /** - * 后端详情 - */ + * 后端详情功能方法 + * 根据传入的公告信息记录的id，从数据库中查询对应的详细信息，进行实体转视图操作以及字典表数据转换后返回给前端。 + * @param id 要查询的公告信息记录的唯一标识（Long类型的id） + * @param request HttpServletRequest对象，用于获取请求相关的信息（如会话中的属性等），可能在字典表数据转换时会用到 + * @return R类型的结果对象，包含操作结果状态以及查询到的详细数据等信息（若查询到数据则返回成功及数据，否则返回错误提示） + */ @RequestMapping("/info/{id}") - public R info(@PathVariable("id") Long id, HttpServletRequest request){ - logger.debug("info方法:,,Controller:{},,id:{}",this.getClass().getName(),id); + public R info(@PathVariable("id") Long id, HttpServletRequest request) { + logger.debug("info方法:,,Controller:{},,id:{}", this.getClass().getName(), id); + // 通过newsService根据传入的id从数据库中查询对应的NewsEntity对象（NewsEntity可能是数据库对应的实体类） NewsEntity news = newsService.selectById(id); - if(news !=null){ - //entity转view + if (news!= null) { + // 创建NewsView对象， + // 用于将查询到的实体数据转换为适合展示的视图数据（NewsView可能包含了部分需要展示给前端的字段等） NewsView view = new NewsView(); - BeanUtils.copyProperties( news , view );//把实体数据重构到view中 + // 使用Spring的BeanUtils工具， + // 将news实体对象中的属性值复制到view视图对象中，实现实体转视图的基本数据复制 + BeanUtils.copyProperties(news, view); - //修改对应字典表字段 + // 对view视图对象进行字典表数据转换操作， + // 将字典表相关字段转换为有实际意义的展示值（比如将类型编码转换为类型名称等） dictionaryService.dictionaryConvert(view, request); + // 返回包含处理后详细数据的成功结果对象（R.ok()表示操作成功， + // 并将数据放入返回对象中返回给前端） return R.ok().put("data", view); - }else { - return R.error(511,"查不到数据"); + } else { + // 如果未查询到对应的数据， + // 则返回包含错误码和错误提示信息的错误结果对象 + return R.error(511, "查不到数据"); } - } /** - * 后端保存 - */ + * 后端保存功能方法 + * 接收前端传来的NewsEntity对象（包含要保存的公告信息相关数据）以及HttpServletRequest对象， + * 检查数据是否重复后将数据插入到数据库中。 + * @param news 包含要保存的公告信息相关数据的NewsEntity对象，包含如公告名称、类型等各种属性信息 + * @param request HttpServletRequest对象，用于获取请求相关的信息（如会话中的用户角色等属性），不过此处暂时未体现更多使用场景 + * @return R类型的结果对象，包含操作结果状态（成功或失败及对应的提示信息） + */ @RequestMapping("/save") - public R save(@RequestBody NewsEntity news, HttpServletRequest request){ - logger.debug("save方法:,,Controller:{},,news:{}",this.getClass().getName(),news.toString()); + public R save(@RequestBody NewsEntity news, HttpServletRequest request) { + logger.debug("save方法:,,Controller:{},,news:{}", this.getClass().getName(), news.toString()); String role = String.valueOf(request.getSession().getAttribute("role")); - if(false) - return R.error(511,"永远不会进入"); + if (false) + return R.error(511, "永远不会进入"); + // 创建EntityWrapper对象，用于构建查询条件， + // 检查数据库中是否已经存在相同的公告信息（根据公告名称和公告类型等字段进行等值判断） Wrapper queryWrapper = new EntityWrapper() - .eq("news_name", news.getNewsName()) - .eq("news_types", news.getNewsTypes()) - ; + .eq("news_name", news.getNewsName()) + .eq("news_types", news.getNewsTypes()); - logger.info("sql语句:"+queryWrapper.getSqlSegment()); + logger.info("sql语句:" + queryWrapper.getSqlSegment()); + // 根据构建的查询条件查询数据库中是否已经存在相同的数据（通过selectOne方法查询一条符合条件的数据） NewsEntity newsEntity = newsService.selectOne(queryWrapper); - if(newsEntity==null){ + if (newsEntity == null) { + // 如果不存在相同数据，则设置公告信息的插入时间和创建时间为当前时间， + // 并将该公告信息插入到数据库中（通过insert方法） news.setInsertTime(new Date()); news.setCreateTime(new Date()); newsService.insert(news); return R.ok(); - }else { - return R.error(511,"表中有相同数据"); + } else { + // 如果存在相同数据，则返回包含错误码和提示信息的错误结果对象，表示表中已有相同数据 + return R.error(511, "表中有相同数据"); } } /** - * 后端修改 - */ + * 后端修改功能方法 + * 接收前端传来的NewsEntity对象（包含要修改的公告信息相关数据）以及HttpServletRequest对象， + * 根据字段查询是否有相同数据，若不存在则根据id更新数据库中的对应公告信息记录，同时对图片字段进行空值处理。 + * @param news 包含要修改的公告信息相关数据的NewsEntity对象，包含如公告名称、类型、图片等各种属性信息，且部分属性可能已被修改 + * @param request HttpServletRequest对象，用于获取请求相关的信息（如会话中的用户角色等属性），不过此处暂时未体现更多使用场景 + * @return R类型的结果对象，包含操作结果状态（成功或失败及对应的提示信息） + */ @RequestMapping("/update") - public R update(@RequestBody NewsEntity news, HttpServletRequest request){ - logger.debug("update方法:,,Controller:{},,news:{}",this.getClass().getName(),news.toString()); + public R update(@RequestBody NewsEntity news, HttpServletRequest request) { + logger.debug("update方法:,,Controller:{},,news:{}", this.getClass().getName(), news.toString()); String role = String.valueOf(request.getSession().getAttribute("role")); -// if(false) -// return R.error(511,"永远不会进入"); - //根据字段查询是否有相同数据 +// if (false) +// return R.error(511, "永远不会进入"); + // 创建EntityWrapper对象，用于构建查询条件，检查数据库中除了当前要修改的记录（根据id排除）外是否存在相同的公告信息（根据公告名称和公告类型等字段进行等值判断） Wrapper queryWrapper = new EntityWrapper() - .notIn("id",news.getId()) - .andNew() - .eq("news_name", news.getNewsName()) - .eq("news_types", news.getNewsTypes()) - ; + .notIn("id", news.getId()) + .andNew() + .eq("news_name", news.getNewsName()) + .eq("news_types", news.getNewsTypes()); + + logger.info("sql语句:" + queryWrapper.getSqlSegment()); - logger.info("sql语句:"+queryWrapper.getSqlSegment()); + // 根据构建的查询条件查询数据库中是否已经存在相同的数据（通过selectOne方法查询一条符合条件的数据） NewsEntity newsEntity = newsService.selectOne(queryWrapper); - if("".equals(news.getNewsPhoto()) || "null".equals(news.getNewsPhoto())){ - news.setNewsPhoto(null); + + // 如果公告图片字段为空字符串或者值为"null" + // （这里可能是前端传递过来的表示空值的情况），则将其设置为null，以便后续正确更新到数据库中 + if ("".equals(news.getNewsPhoto()) || "null".equals(news.getNewsPhoto())) { + news.setNewsPhoto(null); } - if(newsEntity==null){ - newsService.updateById(news);//根据id更新 + if (newsEntity == null) { + + // 如果不存在相同数据， + // 则根据传入的news对象的id更新数据库中的对应公告信息记录（通过updateById方法） + + newsService.updateById(news); return R.ok(); - }else { - return R.error(511,"表中有相同数据"); - } - } + } else { + // 如果存在相同数据， + // 则返回包含错误码和提示信息的错误结果对象，表示表中已有相同数据 + return R.error(511, "表中有相同数据"); + } + } /** - * 删除 - */ + * 删除功能方法 + * 接收前端传来的要删除的公告信息记录的id数组，调用newsService的批量删除方法，从数据库中删除对应的数据记录， + * 并返回操作结果给前端。 + * @param ids 包含要删除的公告信息记录的id的整数数组，用于指定要删除的多条公告信息 + * @return R类型的结果对象，包含操作结果状态（成功或失败及对应的提示信息） + */ @RequestMapping("/delete") - public R delete(@RequestBody Integer[] ids){ - logger.debug("delete:,,Controller:{},,ids:{}",this.getClass().getName(),ids.toString()); + public R delete(@RequestBody Integer[] ids) { + + logger.debug("delete:,,Controller:{},,ids:{}", this.getClass().getName(), ids.toString()); + // 调用newsService的deleteBatchIds方法， + // 批量删除数据库中对应id的公告信息记录（传入的是将数组转换为List后的集合） + newsService.deleteBatchIds(Arrays.asList(ids)); return R.ok(); } - /** - * 批量上传 + * 批量上传功能方法 + * 接收文件名fileName以及HttpServletRequest对象，用于将指定的Excel文件中的公告信息数据批量插入到数据库中， + * 在插入前进行一些文件格式校验、数据读取以及重复数据检查等操作。 + * @param fileName 要上传的文件的名称（这里应该是位于特定目录下的文件名，预期是Excel文件） + * @param request HttpServletRequest对象，用于获取请求相关的信息，如当前用户的ID等属性，可能在后续业务逻辑中有更多用途 + * @return R类型的结果对象，包含操作结果状态（成功或失败及对应的提示信息） */ @RequestMapping("/batchInsert") - public R save( String fileName, HttpServletRequest request){ - logger.debug("batchInsert方法:,,Controller:{},,fileName:{}",this.getClass().getName(),fileName); + public R save(String fileName, HttpServletRequest request) { + logger.debug("batchInsert方法:,,Controller:{},,fileName:{}", this.getClass().getName(), fileName); + + // 从HttpServletRequest的会话中获取当前用户的ID， + // 并转换为Integer类型（这里做了一些强制类型转换操作） + Integer yonghuId = Integer.valueOf(String.valueOf(request.getSession().getAttribute("userId"))); SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); try { - List newsList = new ArrayList<>();//上传的东西 - Map> seachFields= new HashMap<>();//要查询的字段 + + // 创建一个用于存储要插入数据库的NewsEntity对象列表（即从文件中读取到的多条公告信息记录） + List newsList = new ArrayList<>(); + // 创建一个Map， + + // 用于存储要查询是否重复的字段信息（具体的使用方式需看后续代码逻辑，可能用于去重判断等） + Map> seachFields = new HashMap<>(); Date date = new Date(); int lastIndexOf = fileName.lastIndexOf("."); - if(lastIndexOf == -1){ - return R.error(511,"该文件没有后缀"); - }else{ + if (lastIndexOf == -1) { + return R.error(511, "该文件没有后缀"); + } else { String suffix = fileName.substring(lastIndexOf); - if(!".xls".equals(suffix)){ - return R.error(511,"只支持后缀为xls的excel文件"); - }else{ - URL resource = this.getClass().getClassLoader().getResource("static/upload/" + fileName);//获取文件路径 + if (!".xls".equals(suffix)) { + return R.error(511, "只支持后缀为xls的excel文件"); + } else { + // 通过类加载器获取指定文件名对应的文件资源路径（这里应该是位于"static/upload/"目录下的文件） + URL resource = this.getClass().getClassLoader().getResource("static/upload/" + fileName); File file = new File(resource.getFile()); - if(!file.exists()){ - return R.error(511,"找不到上传文件，请联系管理员"); - }else{ - List> dataList = PoiUtil.poiImport(file.getPath());//读取xls文件 - dataList.remove(0);//删除第一行，因为第一行是提示 - for(List data:dataList){ - //循环 + if (!file.exists()) { + return R.error(511, "找不到上传文件，请联系管理员"); + } else { + + // 调用PoiUtil的poiImport方法读取Excel文件中的数据（返回的是一个嵌套的List， + // 外层List表示行，内层List表示每行中的单元格数据） + List> dataList = PoiUtil.poiImport(file.getPath()); + // 删除读取到的数据列表中的第一行（可能是表头之类的提示信息，不需要插入数据库） + dataList.remove(0); + for (List data : dataList) { + // 循环处理每一行数据，创建一个NewsEntity对象，用于存储要插入数据库的一条公告信息记录信息 NewsEntity newsEntity = new NewsEntity(); +// +// +// +// +// +// +// // newsEntity.setNewsName(data.get(0)); //公告标题 要改的 // newsEntity.setNewsTypes(Integer.valueOf(data.get(0))); //公告类型 要改的 // newsEntity.setNewsPhoto("");//详情和图片 @@ -215,91 +309,28 @@ public class NewsController { // newsEntity.setCreateTime(date);//时间 newsList.add(newsEntity); + // 把要查询是否重复的字段放入map中（此处代码未完整实现具体放入逻辑，需补充） - //把要查询是否重复的字段放入map中 } - //查询是否重复 + + // 查询是否重复（此处应该是根据放入seachFields中的字段去检查数据库中是否已存在相同记录， + // 代码可能需完善） newsService.insertBatch(newsList); + return R.ok(); } } } - }catch (Exception e){ + } catch (Exception e) { e.printStackTrace(); - return R.error(511,"批量插入数据异常，请联系管理员"); - } - } - - - - - - /** - * 前端列表 - */ - @IgnoreAuth - @RequestMapping("/list") - public R list(@RequestParam Map params, HttpServletRequest request){ - logger.debug("list方法:,,Controller:{},,params:{}",this.getClass().getName(),JSONObject.toJSONString(params)); - - // 没有指定排序字段就默认id倒序 - if(StringUtil.isEmpty(String.valueOf(params.get("orderBy")))){ - params.put("orderBy","id"); + return R.error(511, "批量插入数据异常，请联系管理员"); } - PageUtils page = newsService.queryPage(params); - - //字典表数据转换 - List list =(List)page.getList(); - for(NewsView c:list) - dictionaryService.dictionaryConvert(c, request); //修改对应字典表字段 - return R.ok().put("data", page); } - /** - * 前端详情 - */ - @RequestMapping("/detail/{id}") - public R detail(@PathVariable("id") Long id, HttpServletRequest request){ - logger.debug("detail方法:,,Controller:{},,id:{}",this.getClass().getName(),id); - NewsEntity news = newsService.selectById(id); - if(news !=null){ - - - //entity转view - NewsView view = new NewsView(); - BeanUtils.copyProperties( news , view );//把实体数据重构到view中 - - //修改对应字典表字段 - dictionaryService.dictionaryConvert(view, request); - return R.ok().put("data", view); - }else { - return R.error(511,"查不到数据"); - } - } - - - /** - * 前端保存 - */ - @RequestMapping("/add") - public R add(@RequestBody NewsEntity news, HttpServletRequest request){ - logger.debug("add方法:,,Controller:{},,news:{}",this.getClass().getName(),news.toString()); - Wrapper queryWrapper = new EntityWrapper() - .eq("news_name", news.getNewsName()) - .eq("news_types", news.getNewsTypes()) - ; - logger.info("sql语句:"+queryWrapper.getSqlSegment()); - NewsEntity newsEntity = newsService.selectOne(queryWrapper); - if(newsEntity==null){ - news.setInsertTime(new Date()); - news.setCreateTime(new Date()); - newsService.insert(news); - return R.ok(); - }else { - return R.error(511,"表中有相同数据"); - } - } - - -} +/** + * 前端列表功能方法 + * 接收前端传来的查询参数以及HttpServletRequest对象，获取公告信息的分页列表数据， + * 并对字典表相关字段进行数据转换后返回给前端，此方法不受权限验证限制（通过@IgnoreAuth注解标识）。 + * @param params 包含查询条件、分页等相关参数的Map集合，例如每页显示数量、页码、排序字段等 + * @param request HttpServletRequest对象，用于获取请求相关的信息，如当前用户的角色、用户ID等，以便添加特定的查询 \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/dao/ForumDao.java b/minsu/minsuguanliw/src/main/java/com/dao/ForumDao.java index 86f6ab46..18850df1 100644 --- a/minsu/minsuguanliw/src/main/java/com/dao/ForumDao.java +++ b/minsu/minsuguanliw/src/main/java/com/dao/ForumDao.java @@ -9,11 +9,11 @@ import com.baomidou.mybatisplus.plugins.pagination.Pagination; import org.apache.ibatis.annotations.Param; import com.entity.view.ForumView; -/** - * 论坛 Dao 接口 - * - * @author - */ +//** + //* 论坛 Dao 接口 + //* + //* @author + //*/ public interface ForumDao extends BaseMapper { List selectListView(Pagination page,@Param("params")Map params); diff --git a/minsu/minsuguanliw/src/main/java/com/dao/NewsDao.java b/minsu/minsuguanliw/src/main/java/com/dao/NewsDao.java index eeaf9176..aa94e050 100644 --- a/minsu/minsuguanliw/src/main/java/com/dao/NewsDao.java +++ b/minsu/minsuguanliw/src/main/java/com/dao/NewsDao.java @@ -9,11 +9,11 @@ import com.baomidou.mybatisplus.plugins.pagination.Pagination; import org.apache.ibatis.annotations.Param; import com.entity.view.NewsView; -/** - * 公告信息 Dao 接口 - * - * @author - */ +//** + // 公告信息 Dao 接口 + //* + //* @author + //*/ public interface NewsDao extends BaseMapper { List selectListView(Pagination page,@Param("params")Map params); diff --git a/minsu/minsuguanliw/src/main/java/com/entity/ForumEntity.java b/minsu/minsuguanliw/src/main/java/com/entity/ForumEntity.java index 1eb3fdae..58f50398 100644 --- a/minsu/minsuguanliw/src/main/java/com/entity/ForumEntity.java +++ b/minsu/minsuguanliw/src/main/java/com/entity/ForumEntity.java @@ -22,243 +22,292 @@ import com.baomidou.mybatisplus.enums.IdType; /** * 论坛 + * 该类定义了论坛相关的数据实体， * - * @author + * + * 对应数据库中的"forum"表，用于存储和传递论坛帖子等相关信息， + * 包含了帖子的各种属性以及对应的Getter、 + * + * Setter方法，同时实现了Serializable接口以支持对象的序列化操作。 + * @author wangmuzi * @email */ @TableName("forum") public class ForumEntity implements Serializable { + // 用于定义序列化版本号， + // 保证在对象序列化和反序列化过程中的兼容性， + // 当类的结构发生变化时可更新该版本号 private static final long serialVersionUID = 1L; + // 无参构造函数，用 + // 于创建ForumEntity对象的默认实例， + // 在一些框架或反射创建对象的场景中可能会用到 + public ForumEntity() { - public ForumEntity() { - - } - - public ForumEntity(T t) { - try { - BeanUtils.copyProperties(this, t); - } catch (IllegalAccessException | InvocationTargetException e) { - // TODO Auto-generated catch block - e.printStackTrace(); - } - } + } + // 有参构造函数，接受一个泛型参数t + //// ，尝试将t对象的属性值复制到当前ForumEntity对象中， + //// 通过BeanUtils进行属性复制 + // ，若出现异常则打印堆栈信息，可用于基于已有对象来初始化该实体对象的场景。 + public ForumEntity(T t) { + try { + BeanUtils.copyProperties(this, t); + } catch (IllegalAccessException | InvocationTargetException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + } - /** - * 主键 + //** + //* 主键 + // * 对应数据库表中记录的唯一标识符， + * 使用了MyBatis Plus的注解来指定主键的相关配置， + * 如设置主键生成策略为自增长（IdType.AUTO）， + * 并指定了数据库表中的字段名为"id"。 */ @TableId(type = IdType.AUTO) @TableField(value = "id") - private Integer id; - - /** - * 帖子标题 + // /** + // * 帖子标题 + // * 用于存储论坛帖子的标题信息， + // * 通过@TableField注解指定了在数据库表"forum"中对应的字段名为"forum_name"。 */ @TableField(value = "forum_name") - private String forumName; - /** * 用户 - */ + // * 用于存储发布该帖子的用户的唯一标识（可能关联到用户表中的用户ID）， + // * 通过@TableField注解指定了在数据库表"forum"中对应的字段名为"yonghu_id"。 + // */ @TableField(value = "yonghu_id") - private Integer yonghuId; - /** - * 管理员 - */ + // * 管理员 + //* 用于存储与该帖子相关的管理员用户的唯一标识（可能在一些管理操作或权限相关场景中有作用）， + // * 通过@TableField注解指定了在数据库表"forum"中对应的字段名为"users_id"。 + //*/ @TableField(value = "users_id") - private Integer usersId; - - /** - * 发布内容 - */ + // /** + //* 发布内容 + // * 用于存储论坛帖子的具体内容信息，通过@TableField注解指定了在数据库表"forum"中对应的字段名为"forum_content"。 + //*/ @TableField(value = "forum_content") - private String forumContent; - - /** - * 父id - */ + // /** + // * 父id + // * 可能用于表示帖子之间的层级关系（比如回复帖子时关联到原帖子的ID等情况）， + //* 通过@TableField注解指定了在数据库表"forum"中对应的字段名为"super_ids"。 + // */ @TableField(value = "super_ids") - private Integer superIds; - - /** - * 帖子状态 - */ + // /** + //* 帖子状态 + // * 用于存储帖子当前所处的状态信息（例如审核状态、是否可见等不同状态，具体含义由业务定义）， + //* 通过@TableField注解指定了在数据库表"forum"中对应的字段名为"forum_state_types"。 + //*/ @TableField(value = "forum_state_types") - private Integer forumStateTypes; - - /** - * 发帖时间 - */ - @JsonFormat(locale="zh", timezone="GMT+8", pattern="yyyy-MM-dd HH:mm:ss") - @DateTimeFormat - @TableField(value = "insert_time",fill = FieldFill.INSERT) - + ///** + // * 发帖时间 + //* 用于记录帖子发布的时间，使用了@JsonFormat注解来指定时间格式化的相关配置，如设置时区、格式化模式等， + // * 使其在序列化为JSON等格式时能以指定格式展示时间，同时通过@DateTimeFormat注解用于在接收前端传入时间格式数据时进行解析， + // * 并且通过@TableField注解指定了该字段在数据库表"forum"中对应的字段名为"insert_time"以及其填充策略为插入时自动填充（FieldFill.INSERT）。 + // */ + @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss") + @DateTimeFormat + @TableField(value = "insert_time", fill = FieldFill.INSERT) private Date insertTime; - - /** - * 修改时间 - */ - @JsonFormat(locale="zh", timezone="GMT+8", pattern="yyyy-MM-dd HH:mm:ss") - @DateTimeFormat - @TableField(value = "update_time",fill = FieldFill.UPDATE) - + // /** + // * 修改时间 + //* 用于记录帖子最后一次被修改的时间，同样使用了@JsonFormat和@DateTimeFormat注解来处理时间的格式化和解析， + //* 通过@TableField注解指定了该字段在数据库表"forum"中对应的字段名为"update_time"以及其填充策略为更新时自动填充（FieldFill.UPDATE）。 + // */ + @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss") + @DateTimeFormat + @TableField(value = "update_time", fill = FieldFill.UPDATE) private Date updateTime; - - /** - * 创建时间 - */ - @JsonFormat(locale="zh", timezone="GMT+8", pattern="yyyy-MM-dd HH:mm:ss") - @DateTimeFormat - @TableField(value = "create_time",fill = FieldFill.INSERT) - + ///** + //* 创建时间 + //* 用于记录帖子相关记录在系统中创建的时间，使用了@JsonFormat和@DateTimeFormat注解来处理时间的格式化和解析， + //* 通过@TableField注解指定了该字段在数据库表"forum"中对应的字段名为"create_time"以及其填充策略为插入时自动填充（FieldFill.INSERT）。 + // */ + @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss") + @DateTimeFormat + @TableField(value = "create_time", fill = FieldFill.INSERT) private Date createTime; - - /** - * 设置：主键 - */ + ///** + //* 设置：主键 + //* Getter方法，用于获取主键id的值，外部代码可以通过该方法获取当前ForumEntity对象的主键值。 + //*/ public Integer getId() { return id; } - /** - * 获取：主键 - */ + ///** + //* 获取：主键 + //* Setter方法，用于设置主键id的值，外部代码可以通过该方法来修改当前ForumEntity对象的主键值。 + //*/ public void setId(Integer id) { this.id = id; } - /** - * 设置：帖子标题 - */ + + ///** + // * 设置：帖子标题 + //* Getter方法，用于获取帖子标题forumName的值，外部代码可以通过该方法获取当前ForumEntity对象的帖子标题。 + // */ public String getForumName() { return forumName; } - /** - * 获取：帖子标题 - */ + ///** + // * 获取：帖子标题 + //* Setter方法，用于设置帖子标题forumName的值，外部代码可以通过该方法来修改当前ForumEntity对象的帖子标题。 + //*/ public void setForumName(String forumName) { this.forumName = forumName; } - /** - * 设置：用户 - */ + + ///** + // * 设置：用户 + //* Getter方法，用于获取用户ID（yonghuId）的值，外部代码可以通过该方法获取当前ForumEntity对象所关联的用户标识。 + //*/ + // + // + // + // public Integer getYonghuId() { return yonghuId; } - /** - * 获取：用户 - */ + // /** + //* 获取：用户 + //* Setter方法，用于设置用户ID（yonghuId）的值，外部代码可以通过该方法来修改当前ForumEntity对象所关联的用户标识。 + //*/ public void setYonghuId(Integer yonghuId) { this.yonghuId = yonghuId; } - /** - * 设置：管理员 - */ + + ///** + //* 设置：管理员 + // * Getter方法，用于获取管理员用户ID（usersId）的值，外部代码可以通过该方法获取当前ForumEntity对象所关联的管理员标识。 + //*/ public Integer getUsersId() { return usersId; } - /** - * 获取：管理员 - */ + ///** + // * 获取：管理员 + // * Setter方法，用于设置管理员用户ID（usersId）的值，外部代码可以通过该方法来修改当前ForumEntity对象所关联的管理员标识。 + // */ public void setUsersId(Integer usersId) { this.usersId = usersId; } - /** - * 设置：发布内容 - */ + + ///** + //* 设置：发布内容 + //* Getter方法，用于获取帖子发布内容（forumContent）的值，外部代码可以通过该方法获取当前ForumEntity对象的帖子具体内容。 + //*/ public String getForumContent() { return forumContent; } - /** - * 获取：发布内容 - */ + // /** + //* 获取：发布内容 + //* Setter方法，用于设置帖子发布内容（forumContent）的值，外部代码可以通过该方法来修改当前ForumEntity对象的帖子具体内容。 + //*/ public void setForumContent(String forumContent) { this.forumContent = forumContent; } - /** - * 设置：父id - */ + + ///** + //* 设置：父id + //* Getter方法，用于获取父ID（superIds）的值，外部代码可以通过该方法获取当前ForumEntity对象所关联的父级帖子标识（如果有层级关系的话）。 + // */ public Integer getSuperIds() { return superIds; } - /** - * 获取：父id - */ + ///** + // * 获取：父id + //* Setter方法，用于设置父ID（superIds）的值，外部代码可以通过该方法来修改当前ForumEntity对象所关联的父级帖子标识（如果有层级关系的话）。 + // */ public void setSuperIds(Integer superIds) { this.superIds = superIds; } - /** - * 设置：帖子状态 - */ + + // /** + // * 设置：帖子状态 + //* Getter方法，用于获取帖子状态（forumStateTypes）的值，外部代码可以通过该方法获取当前ForumEntity对象的帖子当前状态信息。 + //*/ public Integer getForumStateTypes() { return forumStateTypes; } - /** - * 获取：帖子状态 - */ + ///** + // * 获取：帖子状态 + // * Setter方法，用于设置帖子状态（forumStateTypes）的值，外部代码可以通过该方法来修改当前ForumEntity对象的帖子当前状态信息。 + //*/ public void setForumStateTypes(Integer forumStateTypes) { this.forumStateTypes = forumStateTypes; } - /** - * 设置：发帖时间 - */ + + //** + //* 设置：发帖时间 + // * Getter方法，用于获取发帖时间（insertTime）的值，外部代码可以通过该方法获取当前ForumEntity对象的帖子发布时间信息。 + // */ public Date getInsertTime() { return insertTime; } - /** - * 获取：发帖时间 - */ + ///** + //* 获取：发帖时间 + ////* Setter方法，用于设置发帖时间（insertTime）的值，外部代码可以通过该方法来修改当前ForumEntity对象的帖子发布时间信息。 + //*/ public void setInsertTime(Date insertTime) { this.insertTime = insertTime; } - /** - * 设置：修改时间 - */ + + ///** + // * 设置：修改时间 + //* Getter方法，用于获取修改时间（updateTime）的值，外部代码可以通过该方法获取当前ForumEntity对象的帖子最后修改时间信息。 + // */ public Date getUpdateTime() { return updateTime; } - /** - * 获取：修改时间 - */ + ///** + //* 获取：修改时间 + //* Setter方法，用于设置修改时间（updateTime）的值，外部代码可以通过该方法来修改当前ForumEntity对象的帖子最后修改时间信息。 + // */ public void setUpdateTime(Date updateTime) { this.updateTime = updateTime; } - /** - * 设置：创建时间 - */ + + ///** + // * 设置：创建时间 + // * Getter方法，用于获取创建时间（createTime）的值，外部代码可以通过该方法获取当前ForumEntity对象的帖子相关记录创建时间信息。 + // */ public Date getCreateTime() { return createTime; } - /** - * 获取：创建时间 - */ + // /** + // * 获取：创建时间 + //* Setter方法，用于设置创建时间（createTime）的值，外部代码可以通过该方法来修改当前ForumEntity对象的帖子相关记录创建时间信息。 + // */ public void setCreateTime(Date createTime) { this.createTime = createTime; } @@ -266,16 +315,16 @@ public class ForumEntity implements Serializable { @Override public String toString() { return "Forum{" + - "id=" + id + - ", forumName=" + forumName + - ", yonghuId=" + yonghuId + - ", usersId=" + usersId + - ", forumContent=" + forumContent + - ", superIds=" + superIds + - ", forumStateTypes=" + forumStateTypes + - ", insertTime=" + insertTime + - ", updateTime=" + updateTime + - ", createTime=" + createTime + - "}"; + "id=" + id + + ", forumName=" + forumName + + ", yonghuId=" + yonghuId + + ", usersId=" + usersId + + ", forumContent=" + forumContent + + ", superIds=" + superIds + + ", forumStateTypes=" + forumStateTypes + + ", insertTime=" + insertTime + + ", updateTime=" + updateTime + + ", createTime=" + createTime + + "}"; } -} +} \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/entity/NewsEntity.java b/minsu/minsuguanliw/src/main/java/com/entity/NewsEntity.java index e1ded6a8..90dd3c40 100644 --- a/minsu/minsuguanliw/src/main/java/com/entity/NewsEntity.java +++ b/minsu/minsuguanliw/src/main/java/com/entity/NewsEntity.java @@ -20,180 +20,251 @@ import com.baomidou.mybatisplus.annotations.TableField; import com.baomidou.mybatisplus.enums.FieldFill; import com.baomidou.mybatisplus.enums.IdType; -/** - * 公告信息 - * - * @author - * @email - */ +///** + //* 公告信息 + // 该类定义了公告信息相关的数据实体，对应数据库中的"news"表，用于存储和传递公告相关的各种属性信息， + //* 同时实现了Serializable接口，使其能够进行序列化操作，方便在网络传输、持久化等场景中使用， + //* 类中还包含了用于属性访问的Getter和Setter方法以及重写的toString方法，便于对象的操作和信息展示。 + //* @author wangmuzi + //* @email + //*/ @TableName("news") public class NewsEntity implements Serializable { + // + // + // 定义序列化版本号，用于在对象序列化和反序列化过程中确保兼容性， + // 当类的结构发生变化（如新增、删除字段等）时， + // 可适当更新该版本号，以避免出现序列化和反序列化不一致的问题。 private static final long serialVersionUID = 1L; + // 无参构造函数，主要用于创建NewsEntity类的默认实例对象， + // 在一些框架自动实例化对象或者通过反射创建对象等场景下会被调用。 + public NewsEntity() { - public NewsEntity() { - - } - - public NewsEntity(T t) { - try { - BeanUtils.copyProperties(this, t); - } catch (IllegalAccessException | InvocationTargetException e) { - // TODO Auto-generated catch block - e.printStackTrace(); - } - } + } + // 有参构造函数，接受一个泛型参数t， + // 其目的是尝试将传入的t对象的属性值复制到当前的NewsEntity对象中。 + // 通过使用BeanUtils工具类的copyProperties方法来实现属性复制， + // 若在复制过程中出现IllegalAccessException（例如访问权限问题） + // 或者InvocationTargetException（例如被调用方法抛出异常）， + // 则会打印异常堆栈信息进行调试。 + public NewsEntity(T t) { + try { + BeanUtils.copyProperties(this, t); + } catch (IllegalAccessException | InvocationTargetException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + } - /** - * 主键 - */ + ///** + //* 主键 + //* 对应数据库中"news"表记录的唯一标识符， + // * 通过@TableId注解指定了主键的生成策略为自增长（IdType.AUTO）， + //* 并使用@TableField注解明确了在数据库表中的字段名为"id"，用于唯一标识每条公告信息记录。 + //*/ @TableId(type = IdType.AUTO) @TableField(value = "id") - private Integer id; - - /** - * 公告标题 - */ + // /** + // * 公告标题 + // * 用于存储公告的标题内容， + // * 通过@TableField注解将该属性与数据库表"news"中的"news_name"字段进行映射关联， + //// 方便在进行数据库操作时进行数据的存取。 + // */ @TableField(value = "news_name") - private String newsName; - - /** - * 公告类型 - */ + ///** + // * 公告类型 + //* 用于表示公告所属的类型（例如通知类、活动类等， + // * 具体类型由业务逻辑定义），通过@TableField注解将其与数据库表"news"中的"news_types"字段对应起来， + //* 其类型为Integer，可能在数据库中以数字编码形式存储不同的公告类型。 + // */ @TableField(value = "news_types") - private Integer newsTypes; - - - /** - * 公告图片 - */ +// + // /** + // * 公告图片 + // * 用于存放公告相关的图片路径或者图片资源的标识信息（具体取决于业务实现方式，可能是文件系统路径、URL等）， + // * 通过@TableField注解关联到数据库表"news"中的"news_photo"字段，方便进行图片相关的数据操作与存储。 + // */ @TableField(value = "news_photo") - private String newsPhoto; - - /** - * 添加时间 - */ - @JsonFormat(locale="zh", timezone="GMT+8", pattern="yyyy-MM-dd HH:mm:ss") - @DateTimeFormat - @TableField(value = "insert_time",fill = FieldFill.INSERT) - + // /** + // * 添加时间 + // * 用于记录公告信息添加到系统中的时间， + // * 通过@JsonFormat注解来指定时间的格式化方式，使其在序列化为JSON格式数据时能够按照指定的格式展示， + // * 例如设置了中文地区（locale="zh"）、东八区时区（timezone="GMT+8"）以及具体的时间格式（pattern="yyyy-MM-dd HH:mm:ss"）。 + // * 同时，@DateTimeFormat注解用于在接收前端传入的时间格式数据时进行解析转换，使其能正确赋值给该属性。 + // * @TableField注解指定了在数据库表中的字段名为"insert_time"，并且设置了填充策略为插入时自动填充（FieldFill.INSERT）， + //* 意味着在将该实体对象插入数据库时，该时间字段会自动被赋值为当前时间（通常由相关框架自动处理）。 + //*/ + @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss") + @DateTimeFormat + @TableField(value = "insert_time", fill = FieldFill.INSERT) private Date insertTime; - - /** - * 公告详情 - */ + ///** + //* 公告详情 + //* 用于存储公告的详细内容信息， + //* 通过@TableField注解与数据库表"news"中的"news_content"字段进行关联， + // // 方便在进行数据库读写操作时传递和保存公告的详细文本内容。 + // */ @TableField(value = "news_content") - private String newsContent; - - /** - * 创建时间 - */ - @JsonFormat(locale="zh", timezone="GMT+8", pattern="yyyy-MM-dd HH:mm:ss") - @DateTimeFormat - @TableField(value = "create_time",fill = FieldFill.INSERT) - + // /** + // * 创建时间 + // * 类似于添加时间，用于记录公告相关记录在系统中创建的时间， + // * 同样使用了@JsonFormat和@DateTimeFormat注解来处理时间的格式化和解析， + //* 通过@TableField注解指定了该字段在数据库表"news"中对应的字段名为"create_time"以及其填充策略为插入时自动填充（FieldFill.INSERT）， + //* 保证在插入数据时能正确记录创建时间。 + //*/ + @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss") + @DateTimeFormat + @TableField(value = "create_time", fill = FieldFill.INSERT) private Date createTime; - - /** - * 设置：主键 - */ + // /** + // * 设置：主键 + // * 这是属性id的Getter方法， + /// * 外部代码可以通过调用该方法获取当前NewsEntity对象的主键值，方便在业务逻辑中进行基于主键的操作， + ///* 比如查询、更新、删除等操作时使用该主键来定位特定的公告记录。 + //*/ public Integer getId() { return id; } - /** - * 获取：主键 - */ + ///** + // * 获取：主键 + // * 这是属性id的Setter方法，外部代码可以通过调用该方法来设置当前NewsEntity对象的主键值， + // * 不过通常主键在数据库中是由自增长等策略生成， + // * 手动设置的情况相对较少，但在一些特定业务场景下可能会用到，比如数据迁移等情况。 + // */ public void setId(Integer id) { this.id = id; } - /** - * 设置：公告标题 - */ + + // /** + // * 设置：公告标题 + //* 这是属性newsName的Getter方法， + //* 外部代码通过调用它可以获取当前NewsEntity对象所存储的公告标题内容， + //// 便于在展示公告信息或者进行标题相关的业务判断等场景中使用。 + // */ public String getNewsName() { return newsName; } - /** - * 获取：公告标题 - */ + // /** + // * 获取：公告标题 + // * 这是属性newsName的Setter方法， + // * 外部代码调用该方法可以修改当前NewsEntity对象的公告标题内容， + // 比如在编辑公告功能中更新公告的标题时会用到。 + // */ public void setNewsName(String newsName) { this.newsName = newsName; } - /** - * 设置：公告类型 - */ + + // /** + // * 设置：公告类型 + // * 这是属性newsTypes的Getter方法， + // * 外部代码通过调用它可以获取当前NewsEntity对象所代表的公告类型标识（数字编码形式）， + // // 便于在业务逻辑中根据公告类型进行分类处理、查询筛选等操作。 + //*/ public Integer getNewsTypes() { return newsTypes; } - /** - * 获取：公告类型 - */ + // /** + //* 获取：公告类型 + //* 这是属性newsTypes的Setter方法，外部代码调用该方法可以修改当前NewsEntity对象的公告类型标识， + //// 例如在调整公告所属分类等业务场景下会用到。 + //*/ public void setNewsTypes(Integer newsTypes) { this.newsTypes = newsTypes; } - /** - * 设置：公告图片 - */ + + // /** + // * 设置：公告图片 + // * 这是属性newsPhoto的Getter方法， + //* 外部代码通过调用它可以获取当前NewsEntity对象存储的公告图片相关信息（路径或标识等）， + // 在显示公告图片或者对图片资源进行管理等场景中会用到该方法获取相应信息。 + // */ public String getNewsPhoto() { return newsPhoto; } - /** - * 获取：公告图片 - */ + /** + * 获取：公告图片 + * 这是属性newsPhoto的Setter方法， + * 外部代码调用该方法可以修改当前NewsEntity对象的公告图片相关信息， + // 比如更新公告的配图、修改图片路径等业务操作时会用到。 + */ public void setNewsPhoto(String newsPhoto) { this.newsPhoto = newsPhoto; } + /** - * 设置：添加时间 - */ + * 设置：添加时间 + * 这是属性insertTime的Getter方法， + * 外部代码通过调用它可以获取当前NewsEntity对象记录的公告添加时间信息， + // 在查询公告历史记录、按照时间范围筛选公告等业务场景中会用到该时间信息。 + */ public Date getInsertTime() { return insertTime; } - /** - * 获取：添加时间 - */ + /** + * 获取：添加时间 + * 这是属性insertTime的Setter方法， + * 外部代码调用该方法可以修改当前NewsEntity对象的公告添加时间信息， + // 不过一般情况下该时间是由系统自动填充， + 手动修改的情况较少，特殊业务需求下可能会用到（如数据纠错等）。 + */ public void setInsertTime(Date insertTime) { this.insertTime = insertTime; } + /** - * 设置：公告详情 - */ + * 设置：公告详情 + * 这是属性newsContent的Getter方法， + * 外部代码通过调用它可以获取当前NewsEntity对象存储的公告详细内容信息， + // 是展示公告完整内容给用户查看的关键方法，在公告详情页面等场景中会用到。 + */ public String getNewsContent() { return newsContent; } - /** - * 获取：公告详情 - */ + /** + * 获取：公告详情 + * 这是属性newsContent的Setter方法， + * 外部代码调用该方法可以修改当前NewsEntity对象的公告详细内容信息， + // 比如在编辑公告详情文本内容时会用到该方法进行更新操作。 + */ public void setNewsContent(String newsContent) { this.newsContent = newsContent; } + /** - * 设置：创建时间 - */ + * 设置：创建时间 + * 这是属性createTime的Getter方法， + * 外部代码通过调用它可以获取当前NewsEntity对象记录的公告相关记录创建时间信息， + // 在一些涉及到数据创建时间跟踪、按照创建时间排序等业务场景中会用到该时间信息。 + */ public Date getCreateTime() { return createTime; } - /** - * 获取：创建时间 - */ + /** + * 获取：创建时间 + * 这是属性createTime的Setter方法， + * 外部代码调用该方法可以修改当前NewsEntity对象的公告相关记录创建时间信息， + // 通常该时间由系统自动填充，手动修改场景较少，特殊业务场景下（如数据迁移、时间校正等）可能会用到。 + */ public void setCreateTime(Date createTime) { this.createTime = createTime; } @@ -201,13 +272,13 @@ public class NewsEntity implements Serializable { @Override public String toString() { return "News{" + - "id=" + id + - ", newsName=" + newsName + - ", newsTypes=" + newsTypes + - ", newsPhoto=" + newsPhoto + - ", insertTime=" + insertTime + - ", newsContent=" + newsContent + - ", createTime=" + createTime + - "}"; - } -} + "id=" + id + + ", newsName=" + newsName + + ", newsTypes=" + newsTypes + + ", newsPhoto=" + newsPhoto + + ", insertTime=" + insertTime + + ", newsContent=" + newsContent + + ", createTime=" + createTime + + "}"; + } +} \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/entity/model/ForumModel.java b/minsu/minsuguanliw/src/main/java/com/entity/model/ForumModel.java index 423fca17..2a941674 100644 --- a/minsu/minsuguanliw/src/main/java/com/entity/model/ForumModel.java +++ b/minsu/minsuguanliw/src/main/java/com/entity/model/ForumModel.java @@ -1,231 +1,238 @@ package com.entity.model; import com.entity.ForumEntity; - import com.baomidou.mybatisplus.annotations.TableName; import com.fasterxml.jackson.annotation.JsonFormat; import java.util.Date; import org.springframework.format.annotation.DateTimeFormat; import java.io.Serializable; - -/** - * 论坛 - * 接收传参的实体类 - *（实际开发中配合移动端接口开发手动去掉些没用的字段， 后端一般用entity就够用了） - * 取自ModelAndView 的model名称 - */ +// ** +// * 论坛 +// * 接收传参的实体类 +// * （实际开发中配合移动端接口开发手动去掉些没用的字段， 后端一般用entity就够用了） +// * 取自ModelAndView的model名称 +// */ public class ForumModel implements Serializable { - private static final long serialVersionUID = 1L; - - + // 用于定义序列化版本号，在对象序列化和反序列化过程中确保版本兼容性，当类的结构发生变化时，可适当更新此版本号 + private static final long serialVersionUID = 1L; - /** - * 主键 - */ + // ** + // * 主键，用于唯一标识论坛中的每一条记录，通常对应数据库表中的主键字段 + // */ private Integer id; - - /** - * 帖子标题 - */ + // ** + // * 帖子标题，用于存储论坛帖子的标题内容，展示给用户查看帖子主题 + // */ private String forumName; - - /** - * 用户 - */ + // ** + // * 用户，可能关联到发布该帖子的用户的唯一标识（通常是用户ID），用于记录帖子的发布者信息 + // */ private Integer yonghuId; - - /** - * 管理员 - */ + // ** + // * 管理员，可能关联到对该帖子有管理权限的管理员的唯一标识（通常是管理员ID），便于后续进行相关管理操作时确定操作主体 + // */ private Integer usersId; - - /** - * 发布内容 - */ + // ** + // * 发布内容，用于存储用户在论坛中发布帖子的具体文本内容，是帖子的核心信息部分 + // */ private String forumContent; - - /** - * 父id - */ + // ** + // * 父id，可能用于表示当前帖子所属的上级帖子的ID（例如在有回复、跟帖等层级结构的论坛中，用于构建帖子之间的关联关系） + // */ private Integer superIds; - - /** - * 帖子状态 - */ + // ** + // * 帖子状态，用于标记帖子当前所处的状态，比如是正常显示、已删除、待审核等不同状态，不同整数值可对应不同的业务状态含义 + // */ private Integer forumStateTypes; - - /** - * 发帖时间 - */ - @JsonFormat(locale="zh", timezone="GMT+8", pattern="yyyy-MM-dd HH:mm:ss") - @DateTimeFormat + // ** + // * 发帖时间，记录帖子发布的具体时间，通过 @JsonFormat 和 @DateTimeFormat 注解来规范时间格式的序列化与格式化处理，确保在前后端交互以及数据存储等场景下时间格式的一致性 + // * @JsonFormat 注解用于控制在将对象转换为JSON格式时时间的显示格式 + // * @DateTimeFormat 注解用于在接收前端传入时间格式数据时进行解析转换 + // */ + @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss") + @DateTimeFormat private Date insertTime; - - /** - * 修改时间 - */ - @JsonFormat(locale="zh", timezone="GMT+8", pattern="yyyy-MM-dd HH:mm:ss") - @DateTimeFormat + // ** + // * 修改时间，记录帖子最后一次被修改的具体时间，同样使用相关注解保证时间格式处理的正确性，用于跟踪帖子内容更新情况 + // */ + @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss") + @DateTimeFormat private Date updateTime; - - /** - * 创建时间 show2 - */ - @JsonFormat(locale="zh", timezone="GMT+8", pattern="yyyy-MM-dd HH:mm:ss") - @DateTimeFormat + // ** + // * 创建时间 show2，可能是用于特定展示需求或者区分不同创建时间相关概念的字段，同样进行时间格式规范处理，记录帖子相关创建操作对应的时间信息 + // */ + @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss") + @DateTimeFormat private Date createTime; - - /** - * 获取：主键 - */ + // ** + // * 获取：主键，对外提供获取主键值的方法，方便在其他类中访问该对象的主键信息 + // * @return 返回主键对应的整数值 + // */ public Integer getId() { return id; } - - /** - * 设置：主键 - */ + // ** + // * 设置：主键，用于设置该对象的主键值，通常在对象初始化或者从数据库等外部数据源加载数据后更新主键值时使用 + // * @param id 要设置的主键整数值 + // */ public void setId(Integer id) { this.id = id; } - /** - * 获取：帖子标题 - */ + + // ** + // * 获取：帖子标题，对外提供获取帖子标题的方法，以便在业务逻辑中获取并展示或处理帖子标题相关内容 + // * @return 返回帖子标题对应的字符串值 + // */ public String getForumName() { return forumName; } - - /** - * 设置：帖子标题 - */ + // ** + // * 设置：帖子标题，用于更新帖子标题内容，例如用户编辑帖子标题后调用此方法来保存新的标题信息 + // * @param forumName 要设置的帖子标题字符串值 + // */ public void setForumName(String forumName) { this.forumName = forumName; } - /** - * 获取：用户 - */ + + // ** + // * 获取：用户，对外提供获取发布该帖子用户ID的方法，便于在业务逻辑中关联用户相关信息，如查询用户详情等 + // * @return 返回发布帖子的用户对应的ID整数值 + // */ public Integer getYonghuId() { return yonghuId; } - - /** - * 设置：用户 - */ + // ** + // * 设置：用户，用于设置发布该帖子的用户ID，可能在从数据库加载数据或者创建新帖子对象时调用此方法来关联用户信息 + // * @param yonghuId 要设置的用户ID整数值 + // */ public void setYonghuId(Integer yonghuId) { this.yonghuId = yonghuId; } - /** - * 获取：管理员 - */ + + // ** + // * 获取：管理员，对外提供获取对该帖子有管理权限的管理员ID的方法，方便在进行管理操作时确定操作主体相关信息 + // * @return 返回管理员对应的ID整数值 + // */ public Integer getUsersId() { return usersId; } - - /** - * 设置：管理员 - */ + // ** + // * 设置：管理员，用于设置对该帖子有管理权限的管理员ID，例如在分配管理员对特定帖子进行管理等场景下调用此方法来关联管理员信息 + // * @param usersId 要设置的管理员ID整数值 + // */ public void setUsersId(Integer usersId) { this.usersId = usersId; } - /** - * 获取：发布内容 - */ + + // ** + // * 获取：发布内容，对外提供获取帖子发布内容的方法，用于在展示帖子详情、搜索帖子内容等业务场景中获取具体文本信息 + // * @return 返回帖子发布内容对应的字符串值 + // */ public String getForumContent() { return forumContent; } - - /** - * 设置：发布内容 - */ + // ** + // * 设置：发布内容，用于更新帖子的发布内容，例如用户编辑帖子内容后调用此方法来保存新的内容信息 + // * @param forumContent 要设置的发布内容字符串值 + // */ public void setForumContent(String forumContent) { this.forumContent = forumContent; } - /** - * 获取：父id - */ + + // ** + // * 获取：父id，对外提供获取帖子父ID的方法，在处理帖子层级关系相关业务逻辑时（如查询回复所属的原帖等）会用到此信息 + // * @return 返回帖子父ID对应的整数值 + // */ public Integer getSuperIds() { return superIds; } - - /** - * 设置：父id - */ + // ** + // * 设置：父id，用于设置帖子的父ID，例如在创建回复帖子并关联到原帖等场景下调用此方法来构建帖子间的层级关联关系 + // * @param superIds 要设置的父ID整数值 + // */ public void setSuperIds(Integer superIds) { this.superIds = superIds; } - /** - * 获取：帖子状态 - */ + + // ** + // * 获取：帖子状态，对外提供获取帖子当前状态的方法，便于在业务逻辑中根据状态进行不同的处理，如显示、隐藏、审核等操作 + // * @return 返回帖子状态对应的整数值 + // */ public Integer getForumStateTypes() { return forumStateTypes; } - - /** - * 设置：帖子状态 - */ + // ** + // * 设置：帖子状态，用于更新帖子的状态，比如管理员审核通过帖子后调用此方法将状态设置为正常显示等场景下使用 + // * @param forumStateTypes 要设置的帖子状态整数值 + // */ public void setForumStateTypes(Integer forumStateTypes) { this.forumStateTypes = forumStateTypes; } - /** - * 获取：发帖时间 - */ + + // ** + // * 获取：发帖时间，对外提供获取帖子发布时间的方法，在展示帖子信息、按时间排序等业务场景中会用到此时间信息 + // * @return 返回帖子发布时间对应的Date对象 + // */ public Date getInsertTime() { return insertTime; } - - /** - * 设置：发帖时间 - */ + // ** + // * 设置：发帖时间，用于设置帖子的发布时间，一般在创建帖子对象时会根据实际发布时间来调用此方法进行设置 + // * @param insertTime 要设置的发布时间对应的Date对象 + // */ public void setInsertTime(Date insertTime) { this.insertTime = insertTime; } - /** - * 获取：修改时间 - */ + + // ** + // * 获取：修改时间，对外提供获取帖子最后修改时间的方法，在展示帖子历史修改记录、判断内容更新情况等业务场景中会用到此时间信息 + // * @return 返回帖子最后修改时间对应的Date对象 + // */ public Date getUpdateTime() { return updateTime; } - - /** - * 设置：修改时间 - */ + // ** + // * 设置：修改时间，用于更新帖子最后修改时间，在帖子内容被修改后调用此方法来记录最新的修改时间信息 + // * @param updateTime 要设置的最后修改时间对应的Date对象 + // */ public void setUpdateTime(Date updateTime) { this.updateTime = updateTime; } - /** - * 获取：创建时间 show2 - */ + + // ** + // * 获取：创建时间 show2，对外提供获取该特定创建时间字段值的方法，根据具体业务需求在相关场景中使用此时间信息 + // * @return 返回创建时间 show2对应的Date对象 + // */ public Date getCreateTime() { return createTime; } - - /** - * 设置：创建时间 show2 - */ + // ** + // * 设置：创建时间 show2，用于设置该特定创建时间字段的值，在相应的创建相关业务操作场景下调用此方法进行设置 + // * @param createTime 要设置的创建时间 show2对应的Date对象 + // */ public void setCreateTime(Date createTime) { this.createTime = createTime; } - - } +} \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/entity/model/NewsModel.java b/minsu/minsuguanliw/src/main/java/com/entity/model/NewsModel.java index 26424222..5a7cb078 100644 --- a/minsu/minsuguanliw/src/main/java/com/entity/model/NewsModel.java +++ b/minsu/minsuguanliw/src/main/java/com/entity/model/NewsModel.java @@ -1,169 +1,198 @@ package com.entity.model; import com.entity.NewsEntity; - import com.baomidou.mybatisplus.annotations.TableName; import com.fasterxml.jackson.annotation.JsonFormat; import java.util.Date; import org.springframework.format.annotation.DateTimeFormat; import java.io.Serializable; - /** * 公告信息 * 接收传参的实体类 - *（实际开发中配合移动端接口开发手动去掉些没用的字段， 后端一般用entity就够用了） - * 取自ModelAndView 的model名称 + * （实际开发中配合移动端接口开发手动去掉些没用的字段， 后端一般用entity就够用了） + * 取自ModelAndView的model名称 */ public class NewsModel implements Serializable { - private static final long serialVersionUID = 1L; - - + // 用于定义序列化版本号，在对象序列化和反序列化过程中确保版本兼容性， + // 当类的结构发生变化时，可适当更新此版本号 + private static final long serialVersionUID = 1L; - /** - * 主键 - */ + // ** + // * 主键，用于唯一标识每一条公告记录， + // 通常对应数据库表中的主键字段，方便对公告进行查找、更新、删除等操作 + // */ private Integer id; - - /** - * 公告标题 - */ + // ** + // * 公告标题，存储公告的标题内容， + // 用于直观展示公告主题，方便用户快速了解公告大致内容 + // */ private String newsName; - - /** - * 公告类型 - */ + // ** + // * 公告类型，可能用于区分不同种类的公告（例如通知类、活动类、政策类等） + // ，通过不同的整数值对应不同的公告分类，便于后续按类型筛选、展示公告 + // */ private Integer newsTypes; - - /** - * 公告图片 - */ + // ** + // * 公告图片，用于存储公告相关的图片路径或者图片资源的标识等信息 + // （具体取决于项目中图片存储和引用的方式），可用于在前端展示公告时显示对应的图片内容，增强公告的展示效果 + // */ private String newsPhoto; - - /** - * 添加时间 - */ - @JsonFormat(locale="zh", timezone="GMT+8", pattern="yyyy-MM-dd HH:mm:ss") - @DateTimeFormat + // ** + // * 添加时间，记录公告被添加到系统中的具体时间， + // 通过 @JsonFormat 和 @DateTimeFormat + // 注解来规范时间格式的序列化与格式化处理，确保在前后端交互以及数据存储等场景下时间格式的一致性 + // * @JsonFormat 注解用于控制在将对象转换为JSON格式时时间的显示格式 + // * @DateTimeFormat 注解用于在接收前端传入时间格式数据时进行解析转换 + // */ + @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss") + @DateTimeFormat private Date insertTime; - - /** - * 公告详情 - */ + // ** + // * 公告详情，用于存储公告的详细文本内容， + // 是公告的核心信息部分，包含了需要传达给用户的具体事项、说明等内容 + // */ private String newsContent; - - /** - * 创建时间 show1 show2 nameShow - */ - @JsonFormat(locale="zh", timezone="GMT+8", pattern="yyyy-MM-dd HH:mm:ss") - @DateTimeFormat + // ** + // * 创建时间 show1 show2 nameShow， + // 可能是用于满足不同业务场景下对公告创建时间展示需求而设置的字段（比如在不同页面或者功能模块中以不同名称展示创建时间），同样使用相关注解保证时间格式处理的正确性，用于记录公告创建相关的时间信息 + // */ + @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss") + @DateTimeFormat private Date createTime; - - /** - * 获取：主键 - */ + // ** + // * 获取：主键，对外提供获取主键值的方法， + // 方便在其他类中访问该对象的主键信息，例如在进行数据库查询结果映射或者业务逻辑处理中需要用到公告主键时可调用此方法获取 + // * @return 返回主键对应的整数值 + // */ public Integer getId() { return id; } - - /** - * 设置：主键 - */ + // ** + // * 设置：主键，用于设置该对象的主键值， + // 通常在对象初始化或者从数据库等外部数据源加载数据后更新主键值时使用，例如创建新公告对象并保存到数据库前需要设置主键值 + // * @param id 要设置的主键整数值 + // */ public void setId(Integer id) { this.id = id; } - /** - * 获取：公告标题 - */ + + // ** + // * 获取：公告标题，对外提供获取公告标题的方法， + // 以便在业务逻辑中获取并展示或处理公告标题相关内容，比如在前端页面展示公告列表时调用此方法获取标题并显示给用户 + // * @return 返回公告标题对应的字符串值 + // */ public String getNewsName() { return newsName; } - - /** - * 设置：公告标题 - */ + // ** + // * 设置：公告标题，用于更新公告标题内容， + // 例如管理员编辑公告标题后调用此方法来保存新的标题信息 + // * @param newsName 要设置的公告标题字符串值 + // */ public void setNewsName(String newsName) { this.newsName = newsName; } - /** - * 获取：公告类型 - */ + + // ** + // * 获取：公告类型，对外提供获取公告类型的方法， + // 便于在业务逻辑中根据类型进行不同的处理，如按类型分类展示公告、根据类型进行权限控制等操作， + // 可通过返回的整数值判断公告所属类型 + // * @return 返回公告类型对应的整数值 + // */ public Integer getNewsTypes() { return newsTypes; } - - /** - * 设置：公告类型 - */ + // ** + // * 设置：公告类型，用于更新公告的类型， + // 比如管理员对公告重新分类后调用此方法将类型设置为新的分类对应整数值，以反映公告类型的变化 + // * @param newsTypes 要设置的公告类型整数值 + // */ public void setNewsTypes(Integer newsTypes) { this.newsTypes = newsTypes; } - /** - * 获取：公告图片 - */ + + // ** + // * 获取：公告图片，对外提供获取公告图片相关信息的方法， + // 在业务逻辑中用于获取图片信息以在前端展示公告图片，具体返回的字符串根据项目中图片存储和引用方式而定， + // 可能是图片的URL、本地路径等 + // * @return 返回公告图片对应的字符串值 + // */ public String getNewsPhoto() { return newsPhoto; } - - /** - * 设置：公告图片 - */ + // ** + // * 设置：公告图片，用于更新公告的图片信息， + // 例如管理员更换公告图片后调用此方法来保存新的图片相关字符串信息，以更新公告展示时的图片内容 + // * @param newsPhoto 要设置的公告图片字符串值 + // */ public void setNewsPhoto(String newsPhoto) { this.newsPhoto = newsPhoto; } - /** - * 获取：添加时间 - */ + + // ** + // * 获取：添加时间，对外提供获取公告添加时间的方法，在展示公告信息、 + // 按时间排序等业务场景中会用到此时间信息，例如在公告列表中按照添加时间先后顺序展示公告 + // * @return 返回公告添加时间对应的Date对象 + // */ public Date getInsertTime() { return insertTime; } - - /** - * 设置：添加时间 - */ + // ** + // * 设置：添加时间，用于设置公告的添加时间， + // 一般在创建公告对象时会根据实际添加时间来调用此方法进行设置，确保添加时间记录的准确性 + // * @param insertTime 要设置的添加时间对应的Date对象 + // */ public void setInsertTime(Date insertTime) { this.insertTime = insertTime; } - /** - * 获取：公告详情 - */ + + // ** + // * 获取：公告详情，对外提供获取公告详细内容的方法， + // 用于在展示公告详情页面、搜索公告内容等业务场景中获取具体文本信息，以完整呈现公告需要传达的信息 + // * @return 返回公告详情对应的字符串值 + // */ public String getNewsContent() { return newsContent; } - - /** - * 设置：公告详情 - */ + // ** + // * 设置：公告详情，用于更新公告的详细内容， + // 例如管理员编辑公告内容后调用此方法来保存新的内容信息，保证公告详情能及时更新反映最新情况 + // * @param newsContent 要设置的公告详情字符串值 + // */ public void setNewsContent(String newsContent) { this.newsContent = newsContent; } - /** - * 获取：创建时间 show1 show2 nameShow - */ + + // ** + // * 获取：创建时间 show1 show2 nameShow， + // 对外提供获取该特定创建时间字段值的方法，根据具体业务需求在相关场景中使用此时间信息，例如在不同的展示页面按照对应名称展示公告创建时间 + // * @return 返回创建时间 show1 show2 nameShow对应的Date对象 + // */ public Date getCreateTime() { return createTime; } - - /** - * 设置：创建时间 show1 show2 nameShow - */ + // ** + // * 设置：创建时间 show1 show2 nameShow， + // 用于设置该特定创建时间字段的值，在相应的创建相关业务操作场景下调用此方法进行设置，确保创建时间记录符合业务要求 + // * @param createTime 要设置的创建时间 show1 show2 nameShow对应的Date对象 + // */ public void setCreateTime(Date createTime) { this.createTime = createTime; } - - } +} \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/entity/view/ForumView.java b/minsu/minsuguanliw/src/main/java/com/entity/view/ForumView.java index be509379..a0889fe9 100644 --- a/minsu/minsuguanliw/src/main/java/com/entity/view/ForumView.java +++ b/minsu/minsuguanliw/src/main/java/com/entity/view/ForumView.java @@ -12,67 +12,102 @@ import java.util.Date; /** * 论坛 * 后端返回视图实体辅助类 - * （通常后端关联的表或者自定义的字段需要返回使用） + * （通常后端关联的表或者自定义的字段需要返回使用，用于构建适合前端展示或其他业务场景需求的视图数据结构） */ @TableName("forum") public class ForumView extends ForumEntity implements Serializable { - private static final long serialVersionUID = 1L; - - /** - * 帖子状态的值 - */ - private String forumStateValue; - - - - //级联表 yonghu - /** - * 用户姓名 - */ - private String yonghuName; - /** - * 头像 - */ - private String yonghuPhoto; - /** - * 手机号 - */ - private String yonghuPhone; - /** - * 电子邮箱 - */ - private String yonghuEmail; - /** - * 余额 - */ - private Double newMoney; - /** - * 假删 - */ - private Integer yonghuDelete; - - //级联表 users - /** - * 用户名 - */ - private String uusername; - /** - * 密码 - */ - private String upassword; - /** - * 角色 - */ - private String urole; - /** - * 新增时间 - */ - private Date uaddtime; - + private static final long serialVersionUID = 1L; + + // ** + // * 帖子状态的值， + // 用于存储帖子状态对应的具体描述性字符串 + // （可能比单纯用数字表示状态更直观，便于前端直接展示给用户理解帖子当前状态含义） + // */ + private String forumStateValue; + + // 以下是与级联表 yonghu 相关的属性， + // 用于扩展论坛帖子关联的用户相关信息， + // 方便在展示帖子时一并提供用户的详细资料 + + // ** + // * 用户姓名，存储发布该帖子的用户的真实姓名信息， + // 便于在前端展示帖子时显示发布者的姓名，增强信息展示的完整性 + // */ + private String yonghuName; + + // ** + // * 头像，用于存储用户的头像图片相关信息 + // （可能是图片路径、URL或者其他标识，取决于项目中头像存储和引用方式）， + // 以便在前端展示用户头像，提升用户界面的可视化效果 + // */ + private String yonghuPhoto; + + // ** + // * 手机号，存储用户的手机号码信息， + // 在某些业务场景下（比如需要联系用户、验证用户身份等） + // 可能会用到该信息进行相关操作或展示给有权限查看的角色 + // */ + private String yonghuPhone; + + // ** + // * 电子邮箱，保存用户的电子邮箱地址， + // 可用于发送通知、进行账号相关操作验证等业务场景， + // 也可能展示给用户用于沟通联系等用途 + // */ + private String yonghuEmail; + + // ** + // * 余额，可能用于记录用户在系统中的账户余额信息（ + // 例如在涉及支付、消费等功能的论坛系统中，用户可能有相应的资金账户情况）， + // 方便在相关业务逻辑中查询和处理余额相关操作 + // */ + private Double newMoney; + + // ** + // * 假删，可能用于标记用户账号是否处于一种类似“软删除”的状态（ + // 即表面上好像删除了，但实际数据还保留，只是在某些业务场景下不显示等情况），方便进行数据管理和状态控制 + // */ + private Integer yonghuDelete; + + // 以下是与级联表 users 相关的属性， + // 用于扩展与论坛帖子可能关联的管理员或其他相关角色的详细信息 + + // ** + // * 用户名，存储对应管理员或相关角色的用户名， + // 便于在前端展示或者业务逻辑中识别和区分不同的操作主体（比如知道是哪个管理员进行了帖子管理操作等） + // */ + private String uusername; + + // ** + // * 密码，虽然在实际返回给前端的视图数据中通常不会直接展示密码（出于安全考虑）， + // 但在后端业务逻辑处理中，可能涉及到验证、加密等与密码相关的操作，这里存储对应角色的密码信息 + // */ + private String upassword; + + // ** + // * 角色，用于明确该用户在系统中所扮演的角色 + // （例如管理员、普通用户、版主等不同角色具有不同的权限和操作范围），方便进行权限控制和业务流程处理 + // */ + private String urole; + + // ** + // * 新增时间，记录该用户账号 + // （对应管理员或相关角色）在系统中创建的具体时间， + // 可用于查询、统计等业务场景，例如查看新注册的管理员情况等 + // */ + private Date uaddtime; + + // 默认构造函数，用于创建 ForumView + // 对象实例时进行一些默认的初始化操作 + // （目前为空实现，可根据后续需求添加初始化逻辑） public ForumView() { } + // 构造函数，用于根据已有的 ForumEntity 对象来初始化 ForumView 对象， + // 通过 BeanUtils 工具类将 ForumEntity 中的属性值复制到当前对象中 + // 这样可以方便地基于已有的实体对象数据来构建视图对象， + // 减少重复设置属性的操作，提高代码复用性 public ForumView(ForumEntity forumEntity) { try { BeanUtils.copyProperties(this, forumEntity); @@ -82,176 +117,241 @@ public class ForumView extends ForumEntity implements Serializable { } } + // ** + // * 获取： 帖子状态的值， + // 对外提供获取帖子状态对应描述性字符串的方法， + // 以便在前端展示帖子状态信息或者在业务逻辑中根据该字符串进行相应处理 + // * @return 返回帖子状态对应的字符串值 + // */ + public String getForumStateValue() { + return forumStateValue; + } + // ** + // * 设置： 帖子状态的值， + // 用于更新帖子状态对应的描述性字符串， + // 例如当帖子状态发生变化后，通过此方法设置新的状态描述信息，方便后续展示和处理 + // * @param forumStateValue 要设置的帖子状态描述性字符串值 + // */ + public void setForumStateValue(String forumStateValue) { + this.forumStateValue = forumStateValue; + } - /** - * 获取： 帖子状态的值 - */ - public String getForumStateValue() { - return forumStateValue; - } - /** - * 设置： 帖子状态的值 - */ - public void setForumStateValue(String forumStateValue) { - this.forumStateValue = forumStateValue; - } - + // 以下是级联表 yonghu 的一系列获取（get）和设置（set）方法， + // 用于对用户相关属性进行访问和修改操作 + + // ** + // * 获取： 用户姓名，对外提供获取用户姓名的方法， + // 便于在前端展示帖子时获取并显示发布者的姓名信息， + // 或者在业务逻辑中根据姓名进行查询、统计等操作 + // * @return 返回用户姓名对应的字符串值 + // */ + public String getYonghuName() { + return yonghuName; + } + // ** + // * 设置： 用户姓名，用于更新用户的姓名信息， + // 例如用户修改了自己的真实姓名后， + // 通过此方法保存新的姓名数据，以便后续正确展示 + // * @param yonghuName 要设置的用户姓名字符串值 + // */ + public void setYonghuName(String yonghuName) { + this.yonghuName = yonghuName; + } + // ** + // * 获取： 头像，对外提供获取用户头像相关信息的方法， + // 在前端展示用户头像时调用此方法获取对应数据（根据存储方式进行相应的图片展示处理）， + // 也可在业务逻辑中对头像信息进行修改、更新等操作时使用 + // * @return 返回用户头像对应的字符串值（如图片路径、URL等） + // */ + public String getYonghuPhoto() { + return yonghuPhoto; + } + // ** + // * 设置： 头像，用于更新用户的头像信息， + // 比如用户更换了头像图片后，通过此方法保存新的头像相关数据， + // 确保前端展示的头像为最新的图片 + // * @param yonghuPhoto 要设置的用户头像字符串值（如新的图片路径、URL等） + // */ + public void setYonghuPhoto(String yonghuPhoto) { + this.yonghuPhoto = yonghuPhoto; + } + // ** + // * 获取： 手机号，对外提供获取用户手机号码的方法， + // 在需要联系用户、验证身份等业务场景下可调用此方法获取手机号信息， + // 也可用于在前端展示用户信息时包含手机号（需考虑隐私保护相关设置） + // * @return 返回用户手机号对应的字符串值 + // */ + public String getYonghuPhone() { + return yonghuPhone; + } + // ** + // * 设置： 手机号，用于更新用户的手机号码信息， + // 例如用户更换了手机号后，通过此方法保存新的手机号数据， + // 以便后续业务逻辑能正确使用最新的号码 + // * @param yonghuPhone 要设置的用户手机号字符串值 + // */ + public void setYonghuPhone(String yonghuPhone) { + this.yonghuPhone = yonghuPhone; + } + // ** + // * 获取： 电子邮箱，对外提供获取用户电子邮箱地址的方法， + // 在发送通知、账号验证等业务场景下可调用此方法获取邮箱信息， + // 也可在前端展示用户信息时包含邮箱（同样需考虑隐私保护） + // * @return 返回用户电子邮箱对应的字符串值 + // */ + public String getYonghuEmail() { + return yonghuEmail; + } + // ** + // * 设置： 电子邮箱，用于更新用户的电子邮箱地址， + // 例如用户修改了邮箱后，通过此方法保存新的邮箱数据， + // 保证后续相关业务操作使用正确的邮箱信息 + // * @param yonghuEmail 要设置的用户电子邮箱字符串值 + // */ + public void setYonghuEmail(String yonghuEmail) { + this.yonghuEmail = yonghuEmail; + } + // ** + // * 获取： 余额，对外提供获取用户账户余额的方法， + // 在涉及支付、消费、查询余额等业务逻辑中可调用此方法获取余额数值， + // 方便进行相应的资金相关处理 + // * @return 返回用户账户余额对应的 Double 类型数值 + // */ + public Double getNewMoney() { + return newMoney; + } + // ** + // * 设置： 余额，用于更新用户的账户余额信息， + // 比如用户进行充值、消费等操作后，通过此方法保存新的余额数据， + // 确保系统中记录的余额是最新准确的 + // * @param newMoney 要设置的用户账户余额 Double 类型数值 + // */ + public void setNewMoney(Double newMoney) { + this.newMoney = newMoney; + } + // ** + // * 获取： 假删，对外提供获取用户“假删”状态标记的方法， + // 在数据管理、查询已“删除”用户等业务场景下可调用此方法获取该状态值， + // 以便进行相应的业务处理 + // * @return 返回用户“假删”状态对应的整数值（通常是表示是否处于假删状态的标志位） + // */ + public Integer getYonghuDelete() { + return yonghuDelete; + } + // ** + // * 设置： 假删， + // 用于更新用户的“假删”状态标记， + // + // + // + // 例如管理员进行账号删除操作（软删除情况）时， + // + // + // 通过此方法设置相应的状态值，改变用户在系统中的显示和可操作状态 + // * @param yonghuDelete 要设置的用户“假删”状态整数值 + // */ + public void setYonghuDelete(Integer yonghuDelete) { + this.yonghuDelete = yonghuDelete; + } + // 以下是级联表 users 的一系列获取（get）和设置（set）方法， + // 用于对管理员或相关角色的属性进行访问和修改操作 + // ** + // * 获取： 用户名，对外提供获取管理员或相关角色用户名的方法， + // 便于在前端展示帖子管理操作主体信息或者在业务逻辑中根据用户名进行权限判断、操作记录查询等操作 + // * @return 返回用户名对应的字符串值 + // */ + public String getUusername() { + return uusername; + } + // ** + // * 设置： 用户名，用于更新管理员或相关角色的用户名信息， + // 例如管理员修改了自己的用户名后， + // 通过此方法保存新的用户名数据，以便后续正确展示和处理相关业务 + // * @param uusername 要设置的用户名字符串值 + // */ + public void setUusername(String uusername) { + this.uusername = uusername; + } + // ** + // * 获取： 密码，对外提供获取管理员或相关角色密码的方法， + // 虽然在前端视图展示中通常不会直接显示密码， + // 但在后端业务逻辑中涉及密码验证、加密存储等操作时会用到此方法获取密码信息（需确保密码存储和传输的安全性） + // * @return 返回密码对应的字符串值 + // */ + public String getUpassword() { + return upassword; + } + // ** + // * 设置： 密码，用于更新管理员或相关角色的密码信息， + // 比如管理员修改密码后，通过此方法保存新的密码数据， + // 保证系统中存储的密码是最新且符合安全要求的 + // * @param upassword 要设置的密码字符串值 + // */ + public void setUpassword(String upassword) { + this.upassword = upassword; + } + // ** + // * 获取： 角色，对外提供获取管理员或相关角色在系统中所扮演角色的方法， + // 便于在业务逻辑中根据角色进行权限控制、 + // 操作范围限定等处理，例如判断是否具有特定帖子管理权限等 + // * @return 返回角色对应的字符串值（如管理员、普通用户、版主等不同角色名称或标识） + // */ + public String getUrole() { + return urole; + } - //级联表的get和set yonghu + // ** + // * 设置： 角色，用于更新管理员或相关角色的角色信息， + // 例如系统进行角色调整后，通过此方法保存新的角色数据， + // 以便后续根据新角色进行相应的权限和业务流程处理 + // * @param urole 要设置的角色字符串值（如修改后的角色名称或标识） + // */ + public void setUrole(String urole) { + this.urole = urole; + } - /** - * 获取： 用户姓名 - */ - public String getYonghuName() { - return yonghuName; - } - /** - * 设置： 用户姓名 - */ - public void setYonghuName(String yonghuName) { - this.yonghuName = yonghuName; - } + // ** + // * 获取： 新增时间， + // 对外提供获取管理员或相关角色账号创建时间的方法， + // 在查询新注册管理员、 + // 统计账号创建趋势等业务场景下可调用此方法获取时间信息， + // 方便进行相应的数据分析和管理操作 + // * @return 返回新增时间对应的 Date 类型对象 + // */ + public Date getUaddtime() { + return uaddtime; + } - /** - * 获取： 头像 - */ - public String getYonghuPhoto() { - return yonghuPhoto; - } - /** - * 设置： 头像 - */ - public void setYonghuPhoto(String yonghuPhoto) { - this.yonghuPhoto = yonghuPhoto; - } - - /** - * 获取： 手机号 - */ - public String getYonghuPhone() { - return yonghuPhone; - } - /** - * 设置： 手机号 - */ - public void setYonghuPhone(String yonghuPhone) { - this.yonghuPhone = yonghuPhone; - } - - /** - * 获取： 电子邮箱 - */ - public String getYonghuEmail() { - return yonghuEmail; - } - /** - * 设置： 电子邮箱 - */ - public void setYonghuEmail(String yonghuEmail) { - this.yonghuEmail = yonghuEmail; - } - - /** - * 获取： 余额 - */ - public Double getNewMoney() { - return newMoney; - } - /** - * 设置： 余额 - */ - public void setNewMoney(Double newMoney) { - this.newMoney = newMoney; - } - - /** - * 获取： 假删 - */ - public Integer getYonghuDelete() { - return yonghuDelete; - } - /** - * 设置： 假删 - */ - public void setYonghuDelete(Integer yonghuDelete) { - this.yonghuDelete = yonghuDelete; - } - - - - - //级联表的get和set users - - /** - * 获取： 用户名 - */ - public String getUusername() { - return uusername; - } - /** - * 设置： 用户名 - */ - public void setUusername(String uusername) { - this.uusername = uusername; - } - - /** - * 获取： 密码 - */ - public String getUpassword() { - return upassword; - } - /** - * 设置： 密码 - */ - public void setUpassword(String upassword) { - this.upassword = upassword; - } - - /** - * 获取： 角色 - */ - public String getUrole() { - return urole; - } - /** - * 设置： 角色 - */ - public void setUrole(String urole) { - this.urole = urole; - } - - /** - * 获取： 新增时间 - */ - public Date getUaddtime() { - return uaddtime; - } - /** - * 设置： 新增时间 - */ - public void setUaddtime(Date uaddtime) { - this.uaddtime = uaddtime; - } -} + // ** + // * 设置： 新增时间， + // 用于更新管理员或相关角色的账号创建时间信息 + // （虽然在实际业务中一般较少出现修改创建时间的情况， + // 但保留此方法以满足可能的特殊需求）， + // 例如数据迁移、时间校准等场景下可能会用到 + // * @param uaddtime 要设置的新增时间对应的 Date 类型对象 + // */ + public void setUaddtime(Date uaddtime) { + this.uaddtime = uaddtime; + } +} \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/entity/view/NewsView.java b/minsu/minsuguanliw/src/main/java/com/entity/view/NewsView.java index 521f42da..5d6a4302 100644 --- a/minsu/minsuguanliw/src/main/java/com/entity/view/NewsView.java +++ b/minsu/minsuguanliw/src/main/java/com/entity/view/NewsView.java @@ -12,23 +12,38 @@ import java.util.Date; /** * 公告信息 * 后端返回视图实体辅助类 - * （通常后端关联的表或者自定义的字段需要返回使用） + //* （通常后端关联的表或者自定义的字段需要返回使用， + 其目的在于构建适合前端展示或者满足其他业务场景特定需求的数据结构， + + + 方便传递更丰富、直观的数据给前端等调用方） */ @TableName("news") public class NewsView extends NewsEntity implements Serializable { - private static final long serialVersionUID = 1L; - - /** - * 公告类型的值 - */ - private String newsValue; - - - + private static final long serialVersionUID = 1L; + + // ** + // * 公告类型的值， + // 用于存储公告类型对应的具体描述性字符串。 + // + // + // 相较于单纯使用数字等方式表示公告类型，这个字符串形式能更直观地体现公告类型含义， + // + // 方便前端直接展示给用户理解公告所属的具体分类情况 + // */ + private String newsValue; + + // 默认构造函数，用于创建 NewsView 对象实例时进行一 + // 些默认的初始化操作（当前为空实现，后续若有需要可以添加相应的初始化逻辑， + // 比如设置一些默认属性值等） public NewsView() { } + // 构造函数，用于根据已有的 NewsEntity 对象来初始化 NewsView 对象。通 + // 过 BeanUtils 工具类将 NewsEntity 中的属性值复制到当前对象中， + // 这样可以便捷地基于已有的实体对象数据构建视图对象，避免重复逐个设置属性， + // 提高代码复用性，减少代码冗余，方便在不同业务场景下进行对象数据的转换和传递 public NewsView(NewsEntity newsEntity) { try { BeanUtils.copyProperties(this, newsEntity); @@ -38,28 +53,28 @@ public class NewsView extends NewsEntity implements Serializable { } } + // ** + // * 获取： 公告类型的值， + // 对外提供获取公告类型对应描述性字符串的方法， + // 以便在前端展示公告信息时能直观呈现公告类型内容， + // 或者在业务逻辑中根据该字符串进行相应的分类处理、筛选等操作 + // * @return 返回公告类型对应的字符串值 + // */ + public String getNewsValue() { + return newsValue; + } - - /** - * 获取： 公告类型的值 - */ - public String getNewsValue() { - return newsValue; - } - /** - * 设置： 公告类型的值 - */ - public void setNewsValue(String newsValue) { - this.newsValue = newsValue; - } - - - - - - - - - - -} + // ** + // * 设置： 公告类型的值， + // 用于更新公告类型对应的描述性字符串， + // 例如当公告分类发生变化或者需要更准确、 + // + // + // 更符合业务展示需求的类型描述时，通过此方法设置新的类型描述信息， + // 便于后续展示和处理相关业务逻辑 + // * @param newsValue 要设置的公告类型描述性字符串值 + // */ + public void setNewsValue(String newsValue) { + this.newsValue = newsValue; + } +} \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/service/ForumService.java b/minsu/minsuguanliw/src/main/java/com/service/ForumService.java index e08edc95..c3edfad9 100644 --- a/minsu/minsuguanliw/src/main/java/com/service/ForumService.java +++ b/minsu/minsuguanliw/src/main/java/com/service/ForumService.java @@ -8,12 +8,34 @@ import javax.servlet.http.HttpServletRequest; /** * 论坛 服务类 + * 该接口定义了与论坛相关的业务逻辑方法， + * 它继承自 MyBatis Plus 的 IService 接口， + * 意味着可以复用 IService 中提供的一些 + * 通用的数据库操作相关方法，同时在此基础上扩展论坛业务特有的功能方法。 + * 主要用于规范论坛服务层的功能边界， + * 使得不同的实现类能够按照统一的接口定义来实现具体的业务逻辑，便于代码的解耦和维护。 */ public interface ForumService extends IService { /** - * @param params 查询参数 - * @return 带分页的查询出来的数据 - */ - PageUtils queryPage(Map params); + * 查询分页数据的方法， + * 用于根据传入的查询参数获取论坛相关数据，并按照分页的形式返回结果。 + * + * @param params 查询参数，是一个 Map 类型的数据结构，用于传递各种筛选、排序以及分页相关的条件信息。 + * + * + * + * + * + * + * + * + * + * + * 例如，可以包含关键词用于搜索特定主题的论坛帖子，也可以有页码、每页显示数量等分页相关参数， + * 还可以设置其他的自定义筛选条件（如按发布时间范围、用户等进行筛选）。 + * @return 返回一个 PageUtils 类型的对象，该对象封装了分页后的论坛数据以及分页相关的元信息（比如总记录数、总页数等）， + * 方便在前端页面或者其他调用该接口的地方进行分页展示和进一步的数据处理操作。 + */ + PageUtils queryPage(Map params); } \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/service/NewsService.java b/minsu/minsuguanliw/src/main/java/com/service/NewsService.java index 848b053a..1c6ef6e7 100644 --- a/minsu/minsuguanliw/src/main/java/com/service/NewsService.java +++ b/minsu/minsuguanliw/src/main/java/com/service/NewsService.java @@ -8,12 +8,35 @@ import javax.servlet.http.HttpServletRequest; /** * 公告信息 服务类 + * 此接口继承自 MyBatis Plus 的 IService 接 + * 口，目的在于借助 IService 提供的通用数据库操作方法基础， + * 进一步定义与公告信息相关的特定业务逻辑方法， + * 以此规范公告信息服务层的功能范畴，方便后续实现类按照统一标准来实现具体业务， + * 同时也利于代码模块间的解耦， + * 提高代码的可维护性与扩展性。 */ public interface NewsService extends IService { /** - * @param params 查询参数 - * @return 带分页的查询出来的数据 - */ - PageUtils queryPage(Map params); + * 查询分页数据的方法， + * 用于依据传入的查询参数来获取公告信息相关的数据，并将结果以分页的形式进行返回。 + * + * @param params 查询参数，其类型为 Map，这是一个能灵活存储各种键值对的集合类型。 + * 在这里主要用于承载各类与公告信息查询相关的条件设定， + * 例如可以存放用于筛选特定类型公告的条件（如按公告类别区分）、 + * 限定公告发布时间范围的条件， + * 也可以包含分页相关的关键参数，像页码（用于指定要获取第几页的数据）、 + * 每页显示数量（表明每页呈现多少条公告信息）等内容。 + * @return 返回一个 PageUtils 类型的对象， + * 该对象对查询出来的分页公告信息数据进行了统一封装， + * 除了包含具体的公告信息数据外，还整合了分页相关的元数据， + * 比如总记录数（表示符合查询条件的公告总条数）、 + * 总页数 + * （根据每页显示数量和总记录数计算得出的总共可分的页数）等信息， + * + * + * 方便前端页面或者其他调用该接口的地方 + * 能够便捷地进行分页展示以及基于分页数据开展进一步的业务处理操作。 + */ + PageUtils queryPage(Map params); } \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/service/TokenService.java b/minsu/minsuguanliw/src/main/java/com/service/TokenService.java index 903589db..1806a203 100644 --- a/minsu/minsuguanliw/src/main/java/com/service/TokenService.java +++ b/minsu/minsuguanliw/src/main/java/com/service/TokenService.java @@ -1,4 +1,3 @@ - package com.service; import java.util.List; @@ -9,20 +8,92 @@ import com.baomidou.mybatisplus.service.IService; import com.entity.TokenEntity; import com.utils.PageUtils; - /** * token + * 该接口主要用于定义与 token 相关的一系列业务逻辑方法，例如 token 的生成、查询、获取对应实体等操作。 * @author yangliyuan * @date 2019年10月10日 上午9:18:20 */ public interface TokenService extends IService { - PageUtils queryPage(Map params); - - List selectListView(Wrapper wrapper); - - PageUtils queryPage(Map params,Wrapper wrapper); - - String generateToken(Integer userid,String username,String tableName, String role); - - TokenEntity getTokenEntity(String token); -} + + /** + * 查询分页数据的方法， + * 根据传入的查询参数（通常包含分页相关设置以及筛选条件等信息）获取 token 相关数据，并以分页形式返回结果。 + * + * @param params + * + * + * 查询参数，是一个 Map 类型的数据结构，可用于传递如每页显示数量、页码、特定筛选条件（例如按创建时间范围、关联用户等条件筛选 token）等信息， + * 方便灵活地控制查询逻辑，以获取符合业务需求的分页数据。 + * @return 返回一个 PageUtils 类型的对象，该对象封装了分页后的 token 相关数据以及分页相关的元信息，例如总记录数、总页数等， + * 便于在前端展示或者其他需要处理分页数据的地方进行相应操作，如分页展示、数据统计等。 + */ + PageUtils queryPage(Map params); + + /** + * 根据给定的条件包装器（Wrapper）查询并返回符合条件的 TokenEntity 列表。 + * 条件包装器（Wrapper）通常用于构建复杂的查询条件，比如可以灵活组合多个字段的筛选条件（大于、小于、等于关系等）、排序条件等， + * 以此精准地从数据库中获取期望的 token 实体列表。 + * + * @param wrapper + * 用于构建查询条件的包装器对象，它定义了查询 TokenEntity 列表的具体条件， + * + * 例如可以通过它设置只查询某个用户的有效 token、特定角色对应的 token 等各种复杂的筛选逻辑。 + * @return 返回一个包含符合条件的 TokenEntity 对象的列表，列表中的每个 TokenEntity + * 代表了一条符合设定条件的 token 相关记录， + * 方便后续在业务逻辑中对这些查询到的 token 实体进行进一步处理，如验证、更新等操作。 + */ + List selectListView(Wrapper wrapper); + + /** + * 结合查询参数（params）和条件包装器（wrapper）来查询 token 相关数据，并以分页形式返回结果。 + * 这样可以同时利用参数中设定的分页相关设置以及包装器中定义的复杂查询条件，更精准地获取符合业务要求的分页数据。 + * + * @param params 查询参数，同样是 Map 类型，可包含如分页相关的页码、 + * 每页显示数量等基本信息，也可以设置一些通用的筛选条件， + * 辅助细化查询范围，与 wrapper 中的条件共同作用来确定最终的查询结果。 + * @param wrapper 用于构建查询条件的包装器对象，可定义更细致、更复杂的针对 token 的筛选、排序等条件， + * 如根据特定的业务规则筛选出某些特定状态、关联特定用户或角色的 token 等，与 params 配合实现灵活查询。 + * @return 返回一个 PageUtils + * 类型的对象，里面封装了依据上述条件组合查询到的分页后的 token 相关数据以及对应的分页元信息， + * 用于在相应业务场景下进行分页展示和后续的数据处理工作。 + */ + PageUtils queryPage(Map params, Wrapper wrapper); + + /** + * 生成 token 的方法，根据传入的用户相关信息（用户 ID、用户名、所属表名、角色）来创建一个对应的 token 字符串。 + * 在实际应用中，token 常用于用户认证、授权等场景，通过该方法可以基于特定用户的关键信息生成唯一标识该用户的 token， + * 方便后续在系统中进行身份验证和权限控制等操作。 + * + * @param userid + * 用户的唯一标识，通常是一个整数类型的 ID，用于明确是哪个用户对应的 token 正在生成， + * 是区分不同用户 token 的重要依据之一。 + * @param username + * 用户的名称，字符串类型，与 userid 共同进一步确定用户身份，确保生成的 token 与特定用户准确关联。 + * @param tableName + * 所属表名，可能用于标识该用户信息存储所在的数据库表，在一些多表关联或者分表存储的复杂业务场景下， + * 可以帮助更准确地定位和管理与该用户相关的 token 信息，也有助于区分不同业务模块下的 token 生成逻辑。 + * @param role + * + * 用户在系统中所扮演的角色，例如管理员、普通用户等不同角色往往具有不同的权限范围， + * 通过角色信息可以在生成 token 时融入相应的权限特征，便于后续基于 token 进行权限验证等操作。 + * @return 返回生成的 token 字符串，该字符串将作为用户后续在系统中进行操作时的身份验证标识， + * 会在如接口调用、页面访问等场景中被传递和验证，以确定用户是否有权限进行相应操作。 + */ + String generateToken(Integer userid, String username, String tableName, String role); + + /** + * 根据给定的 token 字符串获取对应的 TokenEntity 对象。 + * 在系统中，TokenEntity 可能包含了更多关于 token 的详细信息（如创建时间、过期时间、关联用户等）， + * + * 通过传入一个 token 字符串，能够从数据库或者其他存储介质中查找并返回与之对应的完整 TokenEntity， + * 方便后续进行如 token 有效性验证、更新 token 相关属性等业务操作。 + * + * @param token 要 + * 查找对应实体的 token 字符串，它是之前通过 generateToken 方法等生成的用于标识用户身份的标识信息， + * 作为查找的关键依据，在系统中唯一对应一个 TokenEntity 对象（在符合业务逻辑和数据规范的情况下）。 + * @return 返回与传入的 token 字符串对应的 TokenEntity 对象，如果找到则返回该对象，可进一步获取其中的详细信息进行后续处理； + * 如果未找到符合条件的对象，则可能返回 null（具体取决于实现类中的逻辑），表示该 token 不存在或者无效等情况。 + */ + TokenEntity getTokenEntity(String token); +} \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/service/impl/ForumServiceImpl.java b/minsu/minsuguanliw/src/main/java/com/service/impl/ForumServiceImpl.java index 86986b01..819f0ce0 100644 --- a/minsu/minsuguanliw/src/main/java/com/service/impl/ForumServiceImpl.java +++ b/minsu/minsuguanliw/src/main/java/com/service/impl/ForumServiceImpl.java @@ -19,21 +19,48 @@ import com.entity.view.ForumView; /** * 论坛 服务实现类 + * 该类继承自 MyBatis Plus 的 ServiceImpl 类， + * 用于实现 ForumService 接口中定义的与论坛相关的业务逻辑方法， + * 同时被标记为 Spring 的服务组件（@Service），并 + * 开启了事务管理（@Transactional），确保相关数据库操作的一致性和完整性。 */ @Service("forumService") @Transactional public class ForumServiceImpl extends ServiceImpl implements ForumService { + /** + * 查询分页数据的方法，用 + * 于根据传入的参数获取论坛相关数据的分页信息，并封装成适合返回给前端等调用方使用的格式。 + * + * @param params 一个 Map + * 类型的参数，用于接收各种查询条件和分页相关的参数，例如查询关键字、筛选条件以及页码、每页显示数量等信息。 + * @return 返回一个 PageUtils + * 对象，该对象包含了分页后的论坛数据以及分页相关的元信息（如总记录数、总页数等），方便前端进行分页展示等操作。 + */ @Override - public PageUtils queryPage(Map params) { - if(params != null && (params.get("limit") == null || params.get("page") == null)){ - params.put("page","1"); - params.put("limit","10"); + public PageUtils queryPage(Map params) { + // 如果传入的参数不为空， + // 并且参数中没有设置 "limit"（每页显示数量） + // 或者 "page"（页码）字段，则设置默认的页码为 1，每页显示数量为 10 + if (params!= null && (params.get("limit") == null || params.get("page") == null)) { + params.put("page", "1"); + params.put("limit", "10"); } - Page page =new Query(params).getPage(); - page.setRecords(baseMapper.selectListView(page,params)); - return new PageUtils(page); - } + // 通过传入的参数构建一个 Query 对象， + // 并调用其 getPage 方法获取一个 Page 类型的分页对象， + // 这里 ForumView 可能是一个适合展示给前端的视图实体类， + // 包含了论坛相关数据以及可能关联的其他必要信息。 + Page page = new Query(params).getPage(); + + // 调用 baseMapper（继承自 ServiceImpl 类， + // 实际对应 ForumDao 接口中定义的数据库操作方法）的 selectListView 方法， + // 将分页对象以及查询参数传入，获取符合条件的分页数据列表， + // 并设置到 page 对象的 records 属性中，用于后续封装返回。 + page.setRecords(baseMapper.selectListView(page, params)); -} + // 使用获取到的包含分页数据的 page + // 对象构建并返回一个 PageUtils 对象，将分页数据及相关元信息进行整合封装，方便对外提供统一格式的分页数据结果。 + return new PageUtils(page); + } +} \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/service/impl/NewsServiceImpl.java b/minsu/minsuguanliw/src/main/java/com/service/impl/NewsServiceImpl.java index 6e8af2bf..7bfadfaf 100644 --- a/minsu/minsuguanliw/src/main/java/com/service/impl/NewsServiceImpl.java +++ b/minsu/minsuguanliw/src/main/java/com/service/impl/NewsServiceImpl.java @@ -19,21 +19,47 @@ import com.entity.view.NewsView; /** * 公告信息 服务实现类 + * 该类继承自 MyBatis Plus 的 ServiceImpl 类， + * 用于实现 NewsService 接口中定义的与公告信息相关的业务逻辑方法， + * 同时被标记为 Spring 的服务组件（@Service），并 + * 开启了事务管理（@Transactional），以此确保涉及公告信息相关数据库操作时的一致性和完整性。 */ @Service("newsService") @Transactional public class NewsServiceImpl extends ServiceImpl implements NewsService { + /** + * 查询分页数据的方法，其主要功能是依据传入的参数来获取公告信息相关数据的分页情况， + * 并将其封装成便于返回给前端或者其他调用方使用的格式。 + * + * @param params 一个 Map 类型的参数，该参数用于接收各类查询条件以及分页相关的设定， + * 比如用于筛选公告的特定条件（如公告类型、发布时间范围等）、页码、每页显示的公告数量等信息。 + * @return 返回一个 PageUtils 对象，此对象中包含了经过分页处理后的公告信息数据，同时还整合了分页相关的元数据（例如总记录数、总页数等），方便前端进行分页展示等后续操作。 + */ @Override - public PageUtils queryPage(Map params) { - if(params != null && (params.get("limit") == null || params.get("page") == null)){ - params.put("page","1"); - params.put("limit","10"); + public PageUtils queryPage(Map params) { + // 首先判断传入的参数是否不为空，并且在参数中没有设定 + // "limit"（表示每页显示的公告数量）或者 "page"（表示页码）这两个关键分页参数时， + // 则为其赋予默认值，即将页码设为 1，每页显示的公告数量设为 10，以此确保分页查询能正常进行。 + if (params!= null && (params.get("limit") == null || params.get("page") == null)) { + params.put("page", "1"); + params.put("limit", "10"); } - Page page =new Query(params).getPage(); - page.setRecords(baseMapper.selectListView(page,params)); - return new PageUtils(page); - } + // 通过传入的参数构建一个 Query 类型的对象， + // 并调用其 getPage 方法来获取一个 Page 类型的分页对象。 + // 这里的 NewsView 大概率是一个专门为前端展示等需求而设计的视图实体类， + // 它包含了公告信息以及可能与之关联的其他需要展示的相关信息。 + Page page = new Query(params).getPage(); + + // 调用 baseMapper（它继承自 ServiceImpl 类， + // 实际上对应的是 NewsDao 接口中定义的与数据库操作相关的方法）的 selectListView 方法， + // 把前面获取到的分页对象以及查询参数传递进去，获取符合查询条件的分页数据列表， + // 然后将这些数据设置到 page 对象的 records 属性中，以便后续进行封装并返回。 + page.setRecords(baseMapper.selectListView(page, params)); -} + // 最后，利用已经填充好数据的 page 对象来构建并返回一个 PageUtils 对象， + // 该对象会把分页数据以及与之相关的元数据进行整合封装，对外提供统一格式的分页数据结果，方便其他部分的代码进行使用。 + return new PageUtils(page); + } +} \ No newline at end of file diff --git a/minsu/minsuguanliw/src/main/java/com/service/impl/TokenServiceImpl.java b/minsu/minsuguanliw/src/main/java/com/service/impl/TokenServiceImpl.java index 1e7d8547..6829e63a 100644 --- a/minsu/minsuguanliw/src/main/java/com/service/impl/TokenServiceImpl.java +++ b/minsu/minsuguanliw/src/main/java/com/service/impl/TokenServiceImpl.java @@ -1,7 +1,5 @@ - package com.service.impl; - import java.util.Calendar; import java.util.Date; import java.util.List; @@ -21,60 +19,211 @@ import com.utils.CommonUtil; import com.utils.PageUtils; import com.utils.Query; - /** * token + * 该类是 `TokenService` 接口的实现类， + * 用于具体实现与 token 相关的各项业务逻辑操作，继承自 MyBatis Plus 的 `ServiceImpl` 类， + * 借助其提供的通用数据库操作方法来简化代码编写， + * 并被标记为 Spring 的服务组件（`@Service`）， + * 以便能被 Spring 框架管理和注入到其他需要使用的地方。 * @author */ @Service("tokenService") public class TokenServiceImpl extends ServiceImpl implements TokenService { + /** + * 根据传入的查询参数查询 token 相关数据，并以分页形式返回结果的方法， + * 实现了 `TokenService` 接口中定义的对应方法。 + * 此方法主要利用 MyBatis Plus 提供的分页查询功能， + * 结合传入的参数构建分页查询条件，从数据库中获取符合条件的 token 数据分页信息。 + * + * @param params 查询参数，是一个 Map 类型的数据结构，可包含如页码、 + * 每页显示数量以及其他用于筛选 token 的条件信息（例如按创建时间范围、关联用户等条件进行筛选）， + * 用于控制分页查询的具体逻辑，以获取期望的分页数据。 + * @return 返回一个 `PageUtils` 类型的对象， + * 该对象封装了分页后的 token 相关数据以及分页相关的元信息（比如总记录数、总页数等）， + * 方便在前端展示或者其他业务场景下对分页数据进行处理，例如分页展示、数据统计等操作。 + */ @Override public PageUtils queryPage(Map params) { + // 通过传入的参数构建一个 `Query` 对象， + // 并调用其 `getPage` 方法获取一个 `Page` 类型的分页对象， + // 这个分页对象包含了基本的分页信息（如当前页码、每页显示数量等），用于后续的分页查询操作。 Page page = this.selectPage( - new Query(params).getPage(), - new EntityWrapper() - ); - return new PageUtils(page); + new Query(params).getPage(), + new EntityWrapper() + ); + // 使用获取到的包含分页数据的 `page` + // 对象构建并返回一个 `PageUtils` 对象，将分页数据及相关元信息进行整合封装， + // 对外提供统一格式的分页数据结果，便于其他部分的代码使用。 + return new PageUtils(page); } + /** + * 根据给定的条件包装器（Wrapper）查询并返回符合条件的 + * `TokenEntity` 列表的方法，实现了 `TokenService` 接口中定义的对应方法。 + * 通过调用对应的 `baseMapper` + * （继承自 `ServiceImpl`，实际对应 `TokenDao` 接口中定义的数据库操作方法）的 `selectListView` 方法， + * 依据传入的条件包装器进行数据库查询，获取符合条件的 token 实体列表。 + * + * @param wrapper 用于构建查询条件的包装器对象， + * 它定义了查询 `TokenEntity` 列表的具体条件， + * 例如可以通过它设置只查询某个用户的有效 token、 + * 特定角色对应的 token 等各种复杂的筛选逻辑， + * 作为从数据库中获取期望的 token 实体列表的依据。 + * @return 返回一个包含符合条件的 `TokenEntity` + * 对象的列表，列表中的每个 `TokenEntity` 代表了一条符合设定条件的 token 相关记录， + * 方便后续在业务逻辑中对这些查询到的 token 实体进行进一步处理，如验证、更新等操作。 + */ @Override public List selectListView(Wrapper wrapper) { return baseMapper.selectListView(wrapper); } + /** + * 结合查询参数（params）和条件包装器（wrapper） + * 来查询 token 相关数据，并以分页形式返回结果的方法，实现了 `TokenService` 接口中定义的对应方法。 + * 先是利用传入的参数构建分页对象，再结合条件包装器通过数据库查询获取符合条件的分页数据， + * 最后将数据封装到 `PageUtils` 对象中返回。 + * + * @param params 查询参数，同样是 Map 类型，可包含如分页相关的页码、 + * 每页显示数量等基本信息，也可以设置一些通用的筛选条件， + * 辅助细化查询范围，与 `wrapper` 中的条件共同作用来确定最终的查询结果。 + * @param wrapper 用于构建查询条件的包装器对象，可定义更细致、更复杂的针对 token 的筛选、排序等条件， + * 如根据特定的业务规则筛选出某些特定状态、关联特定用户或角色的 token 等， + * 与 `params` 配合实现灵活查询。 + * @return 返回一个 `PageUtils` 类型的对象， + * 里面封装了依据上述条件组合查询到的分页后的 token 相关数据以及对应的分页元信息， + * 用于在相应业务场景下进行分页展示和后续的数据处理工作。 + */ @Override - public PageUtils queryPage(Map params, - Wrapper wrapper) { - Page page =new Query(params).getPage(); - page.setRecords(baseMapper.selectListView(page,wrapper)); - PageUtils pageUtil = new PageUtils(page); - return pageUtil; + public PageUtils queryPage(Map params, Wrapper wrapper) { + // 通过传入的参数构建一个 `Page` 类型的分页对象，该对象包含了基本的分页设置信息，为后续查询做准备。 + + Page page = new Query(params).getPage(); + // 调用 `baseMapper` 的 `selectListView` 方法，传入分页对象和条件包装器，获取符合条件的分页数据列表， + // 并将这些数据设置到 `page` 对象的 `records` 属性中，填充分页对象的具体数据内容。 + + + + + page.setRecords(baseMapper.selectListView(page, wrapper)); + // 使用填充好数据的 `page` 对象构建一个 `PageUtils` 对象，将分页数据及相关元信息进行整合封装， + // 然后返回这个 `PageUtils` 对象，以便向外提供统一格式的分页数据结果，供其他业务代码使用。 + PageUtils pageUtil = new PageUtils(page); + return pageUtil; } + /** + * 生成 token 的方法，实现了 `TokenService` 接口中定义的对应方法。根据传入的用户相关信息（用户 ID、用户名、所属表名、角色）来创建一个对应的 token 字符串， + * 并处理与该 token 相关的数据库操作， + * 如更新已存在的 token 记录或者插入新的 token 记录等，以保证 token 的有效性和唯一性。 + * + * @param userid 用户的唯一标识， + * 通常是一个整数类型的 ID，用于明确是哪个用户对应的 token 正在生成， + * 是区分不同用户 token 的重要依据之一。 + * @param username 用户的名称，字符串类型，与 `userid` 共同进一步确定用户身份，确保生成的 token 与特定用户准确关联。 + * @param tableName 所属表名，可 + * 能用于标识该用户信息存储所在的数据库表，在一些多表关联或者分表存储的复杂业务场景下， + * 可以帮助更准确地定位和管理与该用户相关的 token 信息，也有助于区分不同业务模块下的 token 生成逻辑。 + * @param role 用户在系统中所扮演的角色，例如管理员、 + * 普通用户等不同角色往往具有不同的权限范围， + * 通过角色信息可以在生成 token 时融入相应的权限特征，便于后续基于 token 进行权限验证等操作。 + * @return 返回生成的 token 字符串， + * 该字符串将作为用户后续在系统中进行操作时的身份验证标识， + * 会在如接口调用、页面访问等场景中被传递和验证，以确定用户是否有权限进行相应操作。 + */ + + @Override - public String generateToken(Integer userid,String username, String tableName, String role) { + public String generateToken(Integer userid, String username, String tableName, String role) { + // 首先尝试从数据库中查找是否已存在该用户 + // （根据传入的 `userid` 和 `role`）对应的 token 记录， + // 通过构建一个 `EntityWrapper` + // 对象设置查询条件（使用 `eq` 方法表示相等条件，即查找 `userid` 和 `role` 与传入值相等的记录）， + // 然后调用 `selectOne` 方法进行查询， + // 如果找到则返回对应的 `TokenEntity` 对象，否则返回 `null`。 TokenEntity tokenEntity = this.selectOne(new EntityWrapper().eq("userid", userid).eq("role", role)); + // 调用工具类 `CommonUtil` 的 `getRandomString` + // 方法生成一个长度为 32 的随机字符串，作为新的 token 值， + // 这个随机字符串将作为唯一标识用户身份的关键信息，用于后续的身份验证等操作。 String token = CommonUtil.getRandomString(32); - Calendar cal = Calendar.getInstance(); - cal.setTime(new Date()); - cal.add(Calendar.HOUR_OF_DAY, 1); - if(tokenEntity!=null) { + // 获取一个 `Calendar` 实例， + // 用于操作日期和时间，这里用于设置 token 的过期时间。 + Calendar cal = Calendar.getInstance(); + // 将 `Calendar` + // 的时间设置为当前时间，以此为基础来计算过期时间。 + cal.setTime(new Date()); + // 给当前时间加上 1 小时， + // 即设置 token 的过期时间为从当前时间起 1 小时后， + // 这样可以控制 token 的有效时长， + // 提高系统的安全性，避免 token 长期有效可能带来的安全风险。 + cal.add(Calendar.HOUR_OF_DAY, 1); + + // 如果之前查询到已存在该用户对应的 token 记录（即 `tokenEntity` 不为 `null`）， + // 则更新该记录的 `token` 值为新生成的 `token` 字符串， + // 并设置其 `expiratedtime`（过期时间）为刚才计算好的时间， + // 最后调用 `updateById` 方法将更新后的 `TokenEntity` + // 对象保存到数据库中，完成 token 的更新操作。 + + + + if (tokenEntity!= null) { tokenEntity.setToken(token); tokenEntity.setExpiratedtime(cal.getTime()); this.updateById(tokenEntity); } else { - this.insert(new TokenEntity(userid,username, tableName, role, token, cal.getTime())); + // 如果之前不存在对应的 token 记录， + // 则创建一个新的 `TokenEntity` 对象， + // 将传入的用户相关信息（`userid`、`username`、`tableName`、`role`）、 + // 新生成的 `token` 字符串以及计算好的过期时间作为参数传入构造函数， + // 然后调用 `insert` 方法将新的 `TokenEntity` 对象插入到数据库中， + // 完成新 token 的创建操作。 + this.insert(new TokenEntity(userid, username, tableName, role, token, cal.getTime())); } + // 最后返回生成的 token 字符串， + // 该字符串将作为后续业务操作中用于验证用户身份的标识信息。 return token; } + /** + * 根据给定的 token 字符串获取对应的 `TokenEntity` + * 对象的方法，实现了 `TokenService` 接口中定义的对应方法。 + * 先从数据库中查找对应 token 的记录，如果找到且该 token 未过期， + * 则返回对应的 `TokenEntity` 对象，否则返回 `null`，以此来验证 token 的有效性。 + * + * @param token 要查找对应实体的 token 字符串， + * 它是之前通过 `generateToken` 方法等生成的用于标识用户身份的标识信息， + * 作为查找的关键依据，在系统中唯一对应一个 `TokenEntity` + * 对象（在符合业务逻辑和数据规范的情况下）。 + * @return 返回与传入的 token 字符串对应的 `TokenEntity` 对象， + * 如果找到则返回该对象，可进一步获取其中的详细信息进行后续处理； + * 如果未找到符合条件的对象（即 `token` 在数据库中不存在或者已过期），则返回 `null`，表示该 token 不存在或者无效等情况。 + */ @Override public TokenEntity getTokenEntity(String token) { + // 通过构建一个 `EntityWrapper` + // 对象设置查询条件（使用 `eq` 方法表示相等条件，即查找 `token` 字段与传入的 `token` 值相等的记录）， + // 然后调用 `selectOne` + // 方法从数据库中查找对应的 `TokenEntity` 对象，如果找到则返回该对象，否则返回 `null`。 + + + + + + TokenEntity tokenEntity = this.selectOne(new EntityWrapper().eq("token", token)); - if(tokenEntity == null || tokenEntity.getExpiratedtime().getTime()