• 72：第六章：开发文章服务：5：开发【发表文章，接口】；

    说明：

    （1）本篇博客内容，开发【发表文章，接口】；

    目录

    一：本篇博客内容，开发【发表文章，接口】；

    二：开发【发表文章，接口】：Controller部分；

    1.在【api】接口工程中，创建ArticleControllerApi接口，定义【发表文章，接口】；

    2.在【article】文章服务中，创建ArticleController类，去实现【发表文章，接口】；

    三：开发【发表文章，接口】：Service部分：去创建一个发表文章的方法；

    1.创建ArticleService接口，定义一个发表文章的方法；

    2.创建ArticleServiceImpl实现类，去实现发表文章的方法； 

    附加一：利用【mybatis-generator-database】工程，根据article表，生成【实体类、mapper接口、mapper.xml】；

    四：效果；

    一：本篇博客内容，开发【发表文章，接口】；

    二：开发【发表文章，接口】：Controller部分；

    1.在【api】接口工程中，创建ArticleControllerApi接口，定义【发表文章，接口】；

    1. package com.imooc.api.controller.article;
    2.  
    3. import com.imooc.bo.NewArticleBO;
    4. import com.imooc.grace.result.GraceJSONResult;
    5. import io.swagger.annotations.Api;
    6. import io.swagger.annotations.ApiOperation;
    7. import org.springframework.validation.BindingResult;
    8. import org.springframework.web.bind.annotation.PostMapping;
    9. import org.springframework.web.bind.annotation.RequestBody;
    10. import org.springframework.web.bind.annotation.RequestMapping;
    11.  
    12. import javax.validation.Valid;
    13.  
    14. @Api(value = "article文章相关Controller",tags = {"article文章相关Controller"})
    15. @RequestMapping("article")  //设置路由，这个是需要前后端约定好的；
    16. public interface ArticleControllerApi {
    17.  
    18.     /**
    19.      * 【发表文章，接口】
    20.      * @param newArticleBO：使用NewArticleBO来承接文章数据；
    21.      * @param result
    22.      * @return
    23.      */
    24.     @ApiOperation(value = "用户发表文章", notes = "用户发表文章", httpMethod = "POST")
    25.     @PostMapping("/createArticle") //设置路由，这个是需要前后端约定好的；
    26.     public GraceJSONResult adminLogin(@RequestBody @Valid NewArticleBO newArticleBO,
    27.                                       BindingResult result);
    28.  
    29. }

    说明：

    （1）该接口的url、请求方式、参数不是瞎写的，需要前后端保持一致；

    （2）我们在【model】模型工程中，创建NewArticleBO类来承接参数；

    1. package com.imooc.bo;
    2.  
    3. import com.fasterxml.jackson.annotation.JsonFormat;
    4. import org.hibernate.validator.constraints.Length;
    5.  
    6. import javax.validation.constraints.Max;
    7. import javax.validation.constraints.Min;
    8. import javax.validation.constraints.NotBlank;
    9. import javax.validation.constraints.NotNull;
    10. import java.util.Date;
    11.  
    12. /**
    13.  * 用户发文的BO
    14.  */
    15. public class NewArticleBO {
    16.  
    17.     @NotBlank(message = "文章标题不能为空")
    18.     @Length(max = 30, message = "文章标题长度不能超过30")
    19.     private String title;
    20.  
    21.     @NotBlank(message = "文章内容不能为空")
    22.     @Length(max = 9999, message = "文章内容长度不能超过10000")
    23.     private String content;
    24.  
    25.     /**
    26.      * 即，文章分类是必须要写的；
    27.      * 而"前端传过来的文章分类"不在"数据库category表"中的判断逻辑，会在后端去做；
    28.      */
    29.     @NotNull(message = "请选择文章领域")
    30.     private Integer categoryId;
    31.  
    32.     @NotNull(message = "请选择正确的文章封面类型")
    33.     @Min(value = 1, message = "请选择正确的文章封面类型")
    34.     @Max(value = 2, message = "请选择正确的文章封面类型")
    35.     private Integer articleType;
    36.     private String articleCover;
    37.  
    38.     @NotNull(message = "文章发布类型不正确")
    39.     @Min(value = 0, message = "文章发布类型不正确")
    40.     @Max(value = 1, message = "文章发布类型不正确")
    41.     private Integer isAppoint;
    42.  
    43.     @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss") // 前端日期字符串传到后端后，转换为Date类型
    44.     private Date publishTime;
    45.  
    46.     @NotBlank(message = "用户未登录")
    47.     private String publishUserId;
    48.  
    49.     public String getTitle() {
    50.         return title;
    51.     }
    52.  
    53.     public void setTitle(String title) {
    54.         this.title = title;
    55.     }
    56.  
    57.     public Integer getCategoryId() {
    58.         return categoryId;
    59.     }
    60.  
    61.     public void setCategoryId(Integer categoryId) {
    62.         this.categoryId = categoryId;
    63.     }
    64.  
    65.     public Integer getArticleType() {
    66.         return articleType;
    67.     }
    68.  
    69.     public void setArticleType(Integer articleType) {
    70.         this.articleType = articleType;
    71.     }
    72.  
    73.     public String getArticleCover() {
    74.         return articleCover;
    75.     }
    76.  
    77.     public void setArticleCover(String articleCover) {
    78.         this.articleCover = articleCover;
    79.     }
    80.  
    81.     public Integer getIsAppoint() {
    82.         return isAppoint;
    83.     }
    84.  
    85.     public void setIsAppoint(Integer isAppoint) {
    86.         this.isAppoint = isAppoint;
    87.     }
    88.  
    89.     public String getPublishUserId() {
    90.         return publishUserId;
    91.     }
    92.  
    93.     public void setPublishUserId(String publishUserId) {
    94.         this.publishUserId = publishUserId;
    95.     }
    96.  
    97.     public String getContent() {
    98.         return content;
    99.     }
    100.  
    101.     public void setContent(String content) {
    102.         this.content = content;
    103.     }
    104.  
    105.     public Date getPublishTime() {
    106.         return publishTime;
    107.     }
    108.  
    109.     public void setPublishTime(Date publishTime) {
    110.         this.publishTime = publishTime;
    111.     }
    112.  
    113.     @Override
    114.     public String toString() {
    115.         return "NewArticleBO{" +
    116.                 "title='" + title + '\'' +
    117.                 ", content='" + content + '\'' +
    118.                 ", categoryId=" + categoryId +
    119.                 ", articleType=" + articleType +
    120.                 ", articleCover='" + articleCover + '\'' +
    121.                 ", isAppoint=" + isAppoint +
    122.                 ", publishTime=" + publishTime +
    123.                 ", publishUserId='" + publishUserId + '\'' +
    124.                 '}';
    125.     }
    126. }

              ● 这BO类，使用了大量的validation参数校验的内容； 

              ● 其中的"@JsonFormat"主要作用是处理前后端传递日期格式数据时的格式问题；具体可以参考【RESTful开发风格6：RESTful基本使用四：JSON序列化；】等文章；

              ● 用户在发表文章时，当向文章中贴图片、设置文章封面的时候；前端会自己去调用【多文件上传，接口】把图片文件上传到阿里OSS上，然后阿里OSS会返回图片的地址url；然后，前端在调用本篇博客的【发表文章，接口】时，这些图片的地址会传送到后端；

    2.在【article】文章服务中，创建ArticleController类，去实现【发表文章，接口】；

    1. package com.imooc.article.controller;
    2.  
    3. import com.imooc.api.BaseController;
    4. import com.imooc.api.controller.article.ArticleControllerApi;
    5. import com.imooc.api.controller.user.HelloControllerApi;
    6. import com.imooc.article.service.ArticleService;
    7. import com.imooc.bo.NewArticleBO;
    8. import com.imooc.enums.ArticleCoverType;
    9. import com.imooc.grace.result.GraceJSONResult;
    10. import com.imooc.grace.result.ResponseStatusEnum;
    11. import com.imooc.pojo.Category;
    12. import com.imooc.utils.JsonUtils;
    13. import org.apache.commons.lang3.StringUtils;
    14. import org.slf4j.Logger;
    15. import org.slf4j.LoggerFactory;
    16. import org.springframework.beans.factory.annotation.Autowired;
    17. import org.springframework.validation.BindingResult;
    18. import org.springframework.web.bind.annotation.RestController;
    19.  
    20. import javax.validation.Valid;
    21. import java.util.List;
    22. import java.util.Map;
    23.  
    24. @RestController
    25. public class ArticleController extends BaseController implements ArticleControllerApi {
    26.  
    27.     final static Logger logger = LoggerFactory.getLogger(ArticleController.class);
    28.     @Autowired
    29.     private ArticleService articleService;
    30.  
    31.  
    32.     /**
    33.      * 【发表文章，接口】
    34.      * @param newArticleBO：使用NewArticleBO来承接文章数据；
    35.      * @param result
    36.      * @return
    37.      */
    38.     @Override
    39.     public GraceJSONResult createArticle(@Valid NewArticleBO newArticleBO,
    40.                                       BindingResult result) {
    41.  
    42.         //0.判断BindingResult中是否保存了验证失败的错误信息，如果有，说明前端的输入是有问题的(用户名或者密码，至少有一个没输入)；
    43.         // 那么，我们就获取这个错误信息，并构建一个GraceJSONResult统一返回对象，返回；
    44.         if (result.hasErrors()) {
    45.             Map map = getErrorsFromBindingResult(result);
    46.             return GraceJSONResult.errorMap(map);
    47.         }
    48.  
    49.         /**
    50.          * 1.判断"文章封面类型"(即NewArticleBO类的articleType字段):
    51.          *      如果文章是有封面的，那么NewArticleBO类的articleCover属性不能为空；
    52.          *      如果文章是没有封面的，那么NewArticleBO类的articleCover属性设置为空；
    53.          */
    54.         //如果文章类型是图文的(即有一张封面)，那么"封面图片的地址，是一定要有的"，即articleCover属性不能为空
    55.         if (newArticleBO.getArticleType() == ArticleCoverType.ONE_IMAGE.type) {
    56.             //此时，如果articleCover属性为空了，直接返回一个信息是"文章封面不存在，请选择一个！"的GraceJSONResult;
    57.             if (StringUtils.isBlank(newArticleBO.getArticleCover())) {
    58.                 return GraceJSONResult.errorCustom(ResponseStatusEnum.ARTICLE_COVER_NOT_EXIST_ERROR);
    59.             }
    60.         }
    61.         //如果文章类型是纯文字的，那么前端articleCover属性是不是为空，无所谓；我们直接把其设置为空即可；
    62.         else if (newArticleBO.getArticleType() == ArticleCoverType.WORDS.type) {
    63.             newArticleBO.setArticleCover("");
    64.         }
    65.  
    66.         /**
    67.          * 2.判断"前端传过来的文章分类"需要在"数据库category表"中；
    68.          *      做法1：根据前端传过来categoryId，直接去数据库的category表中查，看有没有；（但是，
    69.          *          由于【发表文章，接口】是提供给用户的，自然其并发量会是很大的；所以，在这个接口中，
    70.          *          每次都去查询数据库，其实是不太好的；）
    71.          *      做法2：根据前端传过来categoryId，redis中查；（我们在开发【查看文章领域，接口】的时
    72.          *          候，把文章分类数据存到了缓存中；）这儿，我们采用做法2；
    73.          */
    74.         //从redis中，获取所有文章分类的JSON字符串
    75.         String allCategoryJSON= redisOperator.get(REDIS_ALL_CATEGORY);
    76.         //
    77.         /**
    78.          * 如果redis中没有文章分类数据，那么说明系统出了一些相应的问题；我们这儿就可以返回一些提示信息；比如这儿
    79.          * 我们可以返回一个信息是"操作失败，请重试或联系管理员"的GraceJSONResult;（PS：这种情况出现的概率，极低）
    80.          */
    81.         Category temp = null;
    82.         if (StringUtils.isBlank(allCategoryJSON)) {
    83.             return GraceJSONResult.errorCustom(ResponseStatusEnum.SYSTEM_OPERATION_ERROR);
    84.         } else {
    85.             //调用JsonUtils工具类，把JSON转成List;
    86.             List list = JsonUtils.jsonToList(allCategoryJSON, Category.class);
    87.             for (Category category : list) {
    88.                 if (category.getId() == newArticleBO.getCategoryId()) {
    89.                     temp = category;
    90.                     break;//如果找到了，就把找到的赋值给temp，并直接终止循环
    91.                 }
    92.             }
    93.             //如果，至此temp还是为空的话，就说明"前端传过来的文章分类"是不合法的；
    94.             if (temp == null) {
    95.                 //返回一个信息是"请选择正确的文章领域！"的GraceJSONResult;
    96.                 return GraceJSONResult.errorCustom(ResponseStatusEnum.ARTICLE_CATEGORY_NOT_EXIST_ERROR);
    97.             }
    98.         }
    99.  
    100.         // 3. 调用Service层的方法，去新增文章；
    101.         articleService.createArticle(newArticleBO, temp);
    102.         
    103.         return GraceJSONResult.ok();
    104.     }
    105. }

    说明：

    （1）基本逻辑是： 【先判断前端传过来的参数是否OK】→【然后，判断文章类型（是否有封面）和封面图片地址，是否OK】→【然后，判断"前端传过来的文章分类"是否合法】→【然后，调用service层的方法，去发表文章】

    （2）在【common】通用工程中，定义了一个枚举类ArticleCoverType，来表征article_type即文章类型，也就是说文章是否有封面；

    （3）Service层的内容，在三部分中，有介绍；

    三：开发【发表文章，接口】：Service部分：去创建一个发表文章的方法；

    在【article】文章服务中，创建service包，impl包，ArticleService接口，ArticleServiceImpl实现类； 

    1.创建ArticleService接口，定义一个发表文章的方法；

    1. package com.imooc.article.service;
    2.  
    3. import com.imooc.bo.NewArticleBO;
    4. import com.imooc.pojo.Category;
    5.  
    6. import java.io.IOException;
    7.  
    8. /**
    9.  * 定义与【article文章】相关的方法；
    10.  */
    11. public interface ArticleService {
    12.  
    13.     /**
    14.      * 发表文章的方法；
    15.      * @param newArticleBO
    16.      * @param category
    17.      * @return
    18.      * @throws IOException
    19.      */
    20.     public void createArticle(NewArticleBO newArticleBO,
    21.                                 Category category);
    22. }

    2.创建ArticleServiceImpl实现类，去实现发表文章的方法； 

    1. package com.imooc.article.service.impl;
    2.  
    3. import com.imooc.api.service.BaseService;
    4. import com.imooc.article.mapper.ArticleMapper;
    5. import com.imooc.article.service.ArticleService;
    6. import com.imooc.bo.NewArticleBO;
    7. import com.imooc.enums.ArticleAppointType;
    8. import com.imooc.enums.ArticleReviewStatus;
    9. import com.imooc.enums.YesOrNo;
    10. import com.imooc.exception.GraceException;
    11. import com.imooc.grace.result.ResponseStatusEnum;
    12. import com.imooc.pojo.Article;
    13. import com.imooc.pojo.Category;
    14. import org.n3r.idworker.Sid;
    15. import org.springframework.beans.BeanUtils;
    16. import org.springframework.beans.factory.annotation.Autowired;
    17. import org.springframework.stereotype.Service;
    18.  
    19. import java.io.IOException;
    20. import java.util.Date;
    21.  
    22. @Service
    23. public class ArticleServiceImpl extends BaseService implements ArticleService {
    24.  
    25.     @Autowired
    26.     private ArticleMapper articleMapper;
    27.     @Autowired
    28.     private Sid sid;//新增文章时，article表的主键，利用Sid生成；
    29.     /**
    30.      * 发表文章的方法；
    31.      * @param newArticleBO
    32.      * @param category
    33.      * @return
    34.      * @throws IOException
    35.      */
    36.     @Transactional
    37.     @Override
    38.     public void createArticle(NewArticleBO newArticleBO, Category category){
    39.  
    40.         String articleId = sid.nextShort();//利用sid生成一个随机字符串，作为article表的id；
    41.         Article article = new Article();
    42.         BeanUtils.copyProperties(newArticleBO, article);//属性copy，把newArticleBO中的属性，copy到article对象上去；
    43.         article.setId(articleId);//设置主键
    44.         article.setCategoryId(category.getId());//设置categoryId
    45.         article.setArticleStatus(ArticleReviewStatus.REVIEWING.type);//刚提交的文章，其文章状态设为"审核中"；
    46.         article.setCommentCounts(0);//文章初始评论数量设为0
    47.         article.setReadCounts(0);//文章初始阅读数量设为0
    48.         article.setIsDelete(YesOrNo.NO.type);//文章的"逻辑删除状态"，设为0（即在article表中，代表未删除）
    49.         article.setCreateTime(new Date());//设置创建时间
    50.         article.setUpdateTime(new Date());//设置更新时间
    51.         /**
    52.          * 如果文章是定时发布的，就设置publish_time为预约发布时间；
    53.          * 如果文章不是定时发布，而是立即发布，就设置publish_time为当前发布时间；
    54.          */
    55.         if (article.getIsAppoint() == ArticleAppointType.TIMING.type) {
    56.             article.setPublishTime(newArticleBO.getPublishTime());
    57.         } else {
    58.             article.setPublishTime(new Date());
    59.         }
    60.  
    61.         //调用Dao层的方法，去插入
    62.         int res = articleMapper.insert(article);
    63.         if (res != 1) {//如果插入失败,就抛出一个信息是"创建文章失败，请重试或联系管理员！"的自定义异常;
    64.             GraceException.display(ResponseStatusEnum.ARTICLE_CREATE_ERROR);
    65.         }
    66.     }
    67. }

    说明：

    （1） 看注释；

    （2）在【common】通用工程中，创建了ArticleReviewStatus枚举类；来定义文章的审核状态；

    （3）在【common】通用工程中，创建了YesOrNo枚举类；

    （4）在【common】通用工程中，创建了ArticleAppointType枚举类；来表征文章是否是定时发布；

    （5）如果设置属性方面，有不清楚的，看下article表，NewArticleBO类，Article类，就明白了；

    附加一：利用【mybatis-generator-database】工程，根据article表，生成【实体类、mapper接口、mapper.xml】；

    利用【15：第二章：架构后端项目：11：使用【mybatis-generator-core】依赖生成实体类、mapper接口、mapper.xml等逆向文件；】中，创建的【mybatis-generator-database】工程；根据article表，生成【实体类、mapper接口、mapper.xml】；

              ● 把pojo实体类，放到【model】中；

              ● 把mapper接口、mapper.xml，放到【article】中；

    四：效果；

    （1）先install一下整个项目；（2）记得使用SwitchHost开启虚拟域名映射；（3）使用Tomcat启动前端项目；（4）然后，启动后端项目；

    ……………………………………………………

    可以看到，"文章中的图片"和"文章封面图"，在数据库表中存放的都是"图片上传到阿里OSS中的url地址"；

    ……………………………………………………

    ……………………………………………………

    可以看到，我们打印了前端传给后端的NewArticleBO内容：

    NewArticleBO{title='测试文章11', content='<p>发生的附带上p><p><img src="https://imooc-news-dev-wgy.oss-cn-shanghai.aliyuncs.com/image/face/220714DCNP2XK9GC/220812C06BYTMMRP.png"><br>p><p>第三方附带上p>', categoryId=6, articleType=1, articleCover='https://imooc-news-dev-wgy.oss-cn-shanghai.aliyuncs.com/image/face/220714DCNP2XK9GC/220812C07A6P5M14.png', isAppoint=0, publishTime=null, publishUserId='220714DCNP2XK9GC'}

    可以看到，我们没有选择定时发布的话，前端传过来的publisTime是null；

  • 相关阅读:
    【深度学习 Pytorch笔记 B站刘二大人 线性模型 Linear-Model 数学原理分析以及源码实现（1/10）】
    WebSocket、服务器推送技术
    使用nginx发布tomcat站点
    SpringBoot + Docker 实现一次构建到处运行
    【卷王秘籍】学了三遍操作系统后，榨干知识点，让面试官自闭！
    [MAUI]深入了解.NET MAUI Blazor与Vue的混合开发
    时序预测 | MATLAB实现贝叶斯优化CNN-BiLSTM时间序列预测(股票价格预测)
    Dapper数据库字段(列)与实体属性名不一致，通过Column特性自动注入映射
    关于Docker compose值IP与域名的映射 之 extra_host
    PhiData 一款开发AI搜索、agents智能体和工作流应用的AI框架
  • 原文地址：https://blog.csdn.net/csucsgoat/article/details/126300316