【项目实战典型案例】06.没有复用思想

一时失言乱红尘 2023-10-11 21:05 35阅读 0赞

#### 目录 ####

*  一、背景介绍
 *   *  1、反例1
     *  2、反例2
 *  二、复用思想
 *   *  1、代码级别
     *  2、模块级别
     *  3、组件级别
     *  4、架构级别
 *  三、思路&方案
 *   *  1、反例一
     *   *  ①、优化代码
         *  ②、测试结果
     *  2、反例二
     *   *  ①、优化代码
         *   *  1）优化前
             *  2）优化后
         *  ②、测试结果
 *  四、总结

## 一、背景介绍 ##

我们在开发项目的过程中非常容易出现的一种现象就是用什么我就直接写什么，就像我们从数据库读或者存数据一样。我们想要什么数据就从数据库中获取什么样的数据。没有考虑是否浪费了资源的开销。代码是不是复用的问题。

### 1、反例1 ###

![在这里插入图片描述][4231b888ef0e4186b525b5ddbb6a31f0.png]

### 2、反例2 ###

![在这里插入图片描述][77129e7d39564e3bb58587589faab282.png]  
以上两个图都是没有体现复用思想的例子。两个类似的业务场景写了两个接口、两个接口、两个实现类、两个sql，下面我们将上面的代码进行改造。

## 二、复用思想 ##

> 复用思维的核心理念是“不要重复造轮子”，即避免重复编写相同或类似的代码，而是寻找已有的解决方案并进行适当的修改和调整以满足新的需求。复用思维可以应用于不同层次和领域的软件开发，包括代码级别、模块级别、组件级别和架构级别。

### 1、代码级别 ###

复用思维可以通过创建函数、类和库来实现。开发人员可以编写通用的函数或类，将其封装成库，并在需要时引用它们，避免重复编写相同的代码。这样可以提高代码的可维护性和可重用性，并减少开发和测试的工作量。

### 2、模块级别 ###

复用思维可以通过将已有的模块或组件应用于新的项目中来实现。开发人员可以将已经开发和测试过的模块或组件作为独立的模块，并在新的项目中进行集成和配置。这样可以节省开发时间和成本，并提高项目的稳定性和可靠性。

### 3、组件级别 ###

复用思维可以通过使用现有的软件组件或框架来实现。开发人员可以使用第三方库、开源组件或商业框架来构建应用程序，而不是从头开始编写所有的代码。这样可以加快开发速度，降低开发风险，并提供更好的功能和性能。

### 4、架构级别 ###

复用思维可以通过定义和应用标准化的架构模式和设计原则来实现。开发人员可以使用已有的架构模式（如MVC、MVVM等）和设计原则（如单一职责原则、开闭原则等）来指导项目的架构设计和实现。这样可以提高系统的可扩展性、可维护性和可重用性。

> 在JAVA编程语言中是一个抽象类型，是抽象方法的集合，接口通常以interface来声明。一个类通过继承接口的方式，从而来继承接口的抽象方法。简单理解为向外提供统一的行为。

## 三、思路&方案 ##

### 1、反例一 ###

两个查询在线人员的接口我们可以使用一个接口进行实现，两个接口的区别主要是在于入参不一致，我们可以通过使用mybatis的动态SQL进行实现。

#### ①、优化代码 ####

**Controller层**

@PostMapping("/queryCourseContent")
        public List<CourseContentEntity> queryCourseContent(@RequestBody CourseContentEntity courseContent){
        
            return iCourseContentService.queryCourseContent(courseContent);
        }

**IService层**

List<CourseContentEntity> queryCourseContent(CourseContentEntity courseContent);

**ServiceImpl层**

@Resource
        CourseContentMapper courseContentMapper;
    
        @Override
        public List<CourseContentEntity> queryCourseContent(CourseContentEntity courseContent) {
        
            return courseContentMapper.queryCourseContentRecord(courseContent);
        }

**Mapper层**

//通用查询语句
        List<CourseContentEntity> queryCourseContentRecord(CourseContentEntity courseContentEntity);

**Mapper.xml**

<select id="queryCourseContentRecord" resultMap="courseContentMap">
            SELECT id,course_assembly_id,assembly_content,create_time,created_id,created_by,update_time,updated_id,updated_by
            FROM  tar_course_content_info
            WhERE
            is_delete=0
            <if test="id != null"> and id = #{id} </if>
            <if test="courseAssemblyId != null">and course_assembly_id = #{courseAssemblyId}</if>
            <if test="assemblyContent != null">and assembly_content = #{assemblyContent}</if>
            <if test="createdBy != null">and created_by = #{createdBy}</if>
            <if test="updatedBy != null">and updated_by = #{updatedBy}</if>
            <if test="remark != null">and remark = #{remark}</if>
        </select>

#### ②、测试结果 ####

**Body中什么都不传，查出来的所有课程**  
![在这里插入图片描述][960337fc36aa40bab245713612c9e142.png]  
**Body中传入参数，查出来的是某个人创建的课程**  
![在这里插入图片描述][11f4156322204cae9024e730de13d3fb.png]

### 2、反例二 ###

将course\_id和class\_id抽出来作为公共数据使用

#### ①、优化代码 ####

##### 1）优化前 #####

select id,
            user_id,
            user_name,
            questionnaire_id,
            activity_name,
            course_id,
            class_id,
            user_answer,
            start_time,
            update_time,
            remark,
            is_delete
            from
            `arpro_user_answer`
            <where>
                <choose>
                    <when test="id !='' and id != null">
                        and id=#{id}
                    </when>
                    <when test="user_answer !='' and user_answer != null">
                        user_answer=#{user_answer}
                        and course_id = #{course_id}
                        and class_id = #{class_id}
                    </when>
                    <when test="questionnaire_id !='' and questionnaire_id != null">
                        and questionnaire_id=#{questionnaire_id}
                        and course_id = #{course_id}
                        and class_id = #{class_id}
                    </when>
                    <otherwise>
                        and course_id = #{course_id}
                        and class_id = #{class_id}
                        and is_delete = 0
                    </otherwise>
                </choose>
            </where>
        </select>

##### 2）优化后 #####

select id,
            user_id,
            user_name,
            questionnaire_id,
            activity_name,
            course_id,
            class_id,
            user_answer,
            start_time,
            update_time,
            remark,
            is_delete
            from
            `arpro_user_answer`
            <where>
                course_id = #{course_id}
                and class_id = #{class_id}
                and is_delete = 0
                <choose>
                    <when test="id !='' and id != null">
                        and id=#{id}
                    </when>
                    <when test="user_answer !='' and user_answer != null">
                        user_answer=#{user_answer}
                    </when>
                    <when test="questionnaire_id !='' and questionnaire_id != null">
                        and questionnaire_id=#{questionnaire_id}
                    </when>
                </choose>
            </where>
        </select>

#### ②、测试结果 ####

![在这里插入图片描述][5a7951f7e721419cb5a05139c20c7ba1.png]

## 四、总结 ##

在软件设计的时候要从全局观出发，要考虑到前端使用哪些组件，后端使用哪些接口，以及后端需要的接口是有可以复用的。在进行软件设计时，我们也要想是面向对象的设计还是面向过程的设计。如果是面向对象的设计，那么就需要考虑可复用、可扩展、可维护。

[4231b888ef0e4186b525b5ddbb6a31f0.png]: https://img-blog.csdnimg.cn/4231b888ef0e4186b525b5ddbb6a31f0.png
[77129e7d39564e3bb58587589faab282.png]: https://img-blog.csdnimg.cn/77129e7d39564e3bb58587589faab282.png
[960337fc36aa40bab245713612c9e142.png]: https://img-blog.csdnimg.cn/960337fc36aa40bab245713612c9e142.png
[11f4156322204cae9024e730de13d3fb.png]: https://img-blog.csdnimg.cn/11f4156322204cae9024e730de13d3fb.png
[5a7951f7e721419cb5a05139c20c7ba1.png]: https://img-blog.csdnimg.cn/5a7951f7e721419cb5a05139c20c7ba1.png