架构探险-第二章:为Web应用添加业务功能(1)-设计和代码框架

最新推荐文章于 2021-08-04 21:14:24 发布

BraveWangDev

最新推荐文章于 2021-08-04 21:14:24 发布

阅读量374

点赞数

分类专栏：架构探险文章标签： java web 框架

本文链接：https://blog.csdn.net/abap_brave/article/details/80408250

版权

架构探险专栏收录该内容

12 篇文章 0 订阅

订阅专栏

一,前言

由于第二章比较长,且涉及到逐步演进的过程
所以将第二章拆分为多节进行记录
这一节主要针对项目的需求分析可框架搭建

二,需求分析

进入"客户管理"模块,列表查看所有客户
可通过"客户名称"进行模糊查询
列表中,点击"客户名称"链接,查看客户基本信息
"新增"按钮,进入"新增客户"页面,可新增客户基本信息
"编辑"按钮,进入"编辑客户"页面,可更新客户基本信息
"删除"按钮,可删除当前客户

客户基本信息包括:
    客户名称,联系人,电话号码,邮箱,备注

接口设计:
    GET:/customer                       进入"客户列表"界面
    POST:/customer_search               查询客户
    GET:/customer_show?id={id}          进入"查看客户"界面
    GET:/customer_create                进入"创建客户"界面
    POST:/customer_create               创建客户
    GET:/customer_edit?id={id}           进入"编辑客户"界面
    PUT:/customer_edit?id={id}          编辑客户
    DELETE:/customer_delete?id={id}     删除客户

三,创建数据库

创建一个名为demo的数据库
编码方式UTF-8,防止编码不一致导致的中文乱码

这里写图片描述

创建表:

CREATE TABLE `customer` (
    `id` bigint(20) NOT NULL AUTO_INCREMENT,
    `name` varchar(255) DEFAULT NULL,
    `contact` varchar(255) DEFAULT NULL,
    `telephone` varchar(255) DEFAULT NULL,
    `email` varchar(255) DEFAULT NULL,
    `remark` text,
    PRIMARY KEY(`id`)
) ENGINE=INNODB DEFAULT CHARSET=utf8;

添加测试数据:

INSERT INTO `customer` VALUES ('1', 'customer1', 'Brave', '13600000000', 'Brave@gmail.com', null);
INSERT INTO `customer` VALUES ('2', 'customer2', 'BraveWang', '13600000000', 'BraveWang@gmail.com', null);

创建后的数据库截图:

这里写图片描述

建议表明与字段名均为小写,多个单次用"下划线"分割

四,搭建项目

Maven创建Web项目和 Tomcat配置-请参照:使用IDEA构建Maven项目

创建工程目录结构如下:
这里写图片描述

创建了org.smart4j.chapter2包和三个子包
采用了MVC架构搭建Web应用项目结构:Model模型, View视图, Controller控制器
这是一种分层思想,将应用程序分成若干层,每一层做好自己的事情,是"单一职责原则"的应用

pom.xml如下

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.smart4j</groupId>
    <artifactId>chapter2</artifactId>
    <version>1.0.0</version>

    <!--配置项目的打包方式,默认jar-->
    <packaging>war</packaging>

    <!--1,(必须)需要统一源码编码方式,否则Maven编译源码时会出现警告,选用UTF-8-->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <!--Servlet provided:只参与编译,不参与打包(tomcat中也有servlet-api包,会冲突)-->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
            <scope>provided</scope>
        </dependency>
        <!--JSP provided:只参与编译,不参与打包-->
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>jsp-api</artifactId>
            <version>2.2</version>
            <scope>provided</scope>
        </dependency>
        <!--JSTL runtime:运行时生效,不参与编译-->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>1.2</version>
            <scope>runtime</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <!--2,(必须)统一源代码编译输出的JDK版本,本例使用JDK 1.6-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.3</version>
                <configuration>
                    <source>1.6</source>
                    <target>1.6</target>
                </configuration>
            </plugin>
            <!--3,(可选)使用Maven打包时可跳过单元测试-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.18.1</version>
                <configuration>
                    <skipTests>true</skipTests>
                </configuration>
            </plugin>
            <!--通过Maven将应用不是到Tomcat中-->
            <plugin>
                <groupId>org.apache.tomcat.maven</groupId>
                <artifactId>tomcat7-maven-plugin</artifactId>
                <version>2.2</version>
                <configuration>
                    <path>/${project.artifactId}</path>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

五,编写模型层

首先,根据表结构创建模型类:Customer.java

package org.smart4j.chapter2.model;

/**
 * Created by Brave on 18/5/22.
 * 客户模型
 */
public class Customer {

    private long id;            // id
    private String name;        // 客户名称
    private String contact;     // 联系人
    private String telephone;   // 电话号码
    private String email;       // 邮箱地址
    private String remark;      // 备注

    // 省略 getter/setter方法...
}

六,编写控制层

使用servlet作为控制层的实现技术
根据需求分析中的接口设计URL的定义.编写具体的Servlet
Servlet的请求类型GET,POST,PUT,DELETE,分别对应doGet,doPost,doPut,doDelete方法

需要创建一下几个Service:
    CustomerCreateServlet:
        GET:/customer_create                进入"创建客户"界面
        POST:/customer_create               创建客户
    CustomerDeleteServlet:
        DELETE:/customer_delete?id={id}     删除客户
    CustomerEditServlet
        GET:/customer_edit?id={id}          进入"编辑客户"界面
        PUT:/customer_edit?id={id}          编辑客户
    CustomerServlet
        GET:/customer                       进入"客户列表"界面
    CustomerShowServlet
        GET:/customer_show?id={id}          进入"查看客户"界面

    *POST:/customer_search               查询客户

CustomerCreateServlet.java


/**
 * Created by Brave on 18/5/22.
 * 创建客户
 */
@WebServlet("/customer_create")
public class CustomerCreateServlet extends HttpServlet{

    /**
     * 进入 创建客户 界面
     */
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {
        // TODO
    }

    /**
     * 处理 创建客户 请求
     */
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {
        // TODO
    }
}

CustomerDeleteServlet.java

/**
 * Created by Brave on 18/5/22.
 * 删除客户
 */
@WebServlet("customer_delete")
public class CustomerDeleteServlet extends HttpServlet {

    /**
     * 删除客户
     */
    @Override
    protected void doDelete(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {
        // TODO
    }
}

CustomerEditServlet.java

/**
 * Created by Brave on 18/5/22.
 * 编辑客户
 */
@WebServlet("/customer_edit")
public class CustomerEditServlet extends HttpServlet{

    /**
     * 进入 编辑客户 界面
     */
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {
        // TODO
    }

    /**
     * 处理 编辑客户 请求
     */
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {
        // TODO
    }
}

CustomerServlet.java

/**
 * Created by Brave on 18/5/22.
 * 客户列表
 */
@WebServlet("/customer")
public class CustomerServlet extends HttpServlet{

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {
        // TODO
    }
}

CustomerShowServlet.java

/**
 * Created by Brave on 18/5/22.
 * 显示客户基本信息
 */
@WebServlet("/customer_show")
public class CustomerShowServlet extends HttpServlet{

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp)
            throws ServletException, IOException {
        // TODO
    }
}

七,编写服务层

服务层并不在标准的MVC架构中,它是衔接控制器层和数据库之间的桥梁
由于比较简单,这里没有定义接口,直接写出实现类

CustomerService.java

/**
 * Created by Brave on 18/5/22.
 * 提供客户数据服务
 */
public class CustomerService {

    /**
     * 获取客户列表
     */
    public List<Customer> getCustomerList() {
        // TODO
        return null;
    }

    /**
     * 获取客户
     */
    public Customer getCustomer(long id) {
        // TODO
        return null;
    }

    /**
     * 创建客户
     */
    public boolean createCustomer(Map<String, Object> fieldMap) {
        // TODO
        return false;
    }

    /**
     * 更新客户
     */
    public boolean updateCustomer(long id, Map<String, Object> fieldMap) {
        // TODO
        return false;
    }

    /**
     * 删除客户
     */
    public boolean deleteCustomer(long id) {
        // TODO
        return false;
    }
}

七,编写单元测试

pom.xml文件添加JUnit测试框架依赖:

<!-- JUnit -->
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.11</version>
    <scope>test</scope>
</dependency>

在test/java目录创建单元测试包:org.smart4j.chapter2.test
单元测试类:CustomerServiceTest.java,用于测试CustomerService类中的方法

CustomerServiceTest.java:

/**
 * Created by Brave on 18/5/22.
 * 单元测试
 */
public class CustomerServiceTest {

    private final CustomerService customerService;

    public CustomerServiceTest(){
        customerService = new CustomerService();
    }

    @Before
    public void init() {
        // TODO 初始化数据库
    }

    @Test
    public void getCustomerListTest() throws Exception {
        List<Customer> customerList = customerService.getCustomerList();
        Assert.assertEquals(2, customerList.size());
    }

    @Test
    public void getCustomerTest() throws Exception {
        long id = 1;
        Customer customer = customerService.getCustomer(id);
        Assert.assertNotNull(customer);
    }

    @Test
    public void createCustomerTest() throws Exception {
        Map<String, Object> fieldMap = new HashMap<String, Object>();
        fieldMap.put("name", "customer1");
        fieldMap.put("contact", "Brave");
        fieldMap.put("telephone", "13600000000");
        boolean result = customerService.createCustomer(fieldMap);
        Assert.assertTrue(result);
    }

    @Test
    public void deleteCustomerTest() throws Exception {
        long id = 1;
        boolean result = customerService.deleteCustomer(id);
        Assert.assertTrue(result);
    }
}

八,编写视图层

视图层使用JSP,存放于WEB-INF/view目录下
推荐将JSP文件放到WEB-INF内部,
因为用户无法通过浏览器地址栏直接请求放在WEB-INF内部的JSP文件,
必须通过Servlet程序进行转发(forward)或重定向(redirect)

customer_create.jsp创建客户页面:

<%@ page pageEncoding="UTF-8" %>
<html>
<head>
    <title>客户管理 - 创建客户</title>
</head>
<body>

<h1>创建客户界面</h1>

<%-- TODO --%>

</body>
</html>

九,结尾

由于第二章篇幅过长,所以将其拆成几个部分做笔记,
这篇主要是搭建了一个"客户管理"的代码框架,
所有需要代码细化实现的部分都以TODO标记预留
后续将继续对这些部分进行细化和完善及优化

项目结构:
完整项目结构

BraveWangDev

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
打赏
0
评论
架构探险-第二章:为Web应用添加业务功能(1)-设计和代码框架

一,前言由于第二章比较长,且涉及到逐步演进的过程所以将第二章拆分为多节进行记录这一节主要针对项目的需求分析可框架搭建二,需求分析进入&amp;quot;客户管理&amp;quot;模块,列表查看所有客户可通过&amp;quot;客户名称&amp;quot;进行模糊查询列表中,点击&amp;quot;客户名称&amp;quot;链接,查看客户基本信息&amp;quot;新增&amp;quot;按钮,进入&amp;q
复制链接

扫一扫