基於TODO的開發方法

以前買了一本書，叫《架構探險—從零開始寫Java Web框架 》（__不推薦購買～__），一本標題黨書籍！可是我很推崇做者寫代碼的方式，就是基於TODO的方式進行開發！

我的認爲以基於TODO的方式進行開發，至少有以下幾點優點：

• 有助於理解需求
• 有助於梳理業務流程
• 有助於任務拆解和代碼封裝
• TODO即註釋
• 更易於進入心流體驗

__同時還能避免以下兩種狀況__：

下面我以Blog的建立流程爲例，來演示基於TODO的開發方式，並說明爲什麼基於TODO的開發方式有如上優點！

後端的開發框架請見Web開發框架推導！

流程演示

後端開發流程

基於上面的開發框架，總體流程就是Controller->Service->Mapper->Database！
就Blog建立流程來講，咱們會有BlogController->BlogService->BlogMapper->Database的流程！
那咱們的開發流程以下：

__Step1__:

@RestController
public class BlogController{
    //todo 建立blog流程
    //todo 接收參數
    //todo 驗證字段
    //todo 構建Model
    //todo 委託BlogService
    //todo 返回blog主鍵
    //todo 處理可能異常    
}

@Service
public class BlogService{
    //todo 建立blog
    //todo 設置建立信息
    //todo 委託blogMapper執行
    //todo 返回主鍵
}

__Step2__:

@RestController
public class BlogController{
    //建立blog流程
    @PostMapping("/blog")
    public Long create(BlogDto blog){
        //todo 接收參數
        //todo 驗證字段
        //todo 構建Model
        //todo 委託BlogService
        //todo 返回blog主鍵
        //todo 處理可能異常    
        return null;
    }
}

__Step3__:

@RestController
public class BlogController{
    //建立blog流程
    //接收參數
    @PostMapping("/blog")
    public Long create(@RequestBody @Validated BlogDto blog, BindingResult result){
        //驗證字段
        if (bindResult.hasErrors()) {
            throw new BindingException(bindResult.getFieldError().getDefaultMessage());
        }
        //todo 構建Model
        //todo 委託BlogService
        //todo 返回blog主鍵
        //todo 處理可能異常    
        return null;
    }
}

__Step4__:

@RestController
public class BlogController{
    //建立blog流程
    //接收參數
    @PostMapping("/blog")
    public ResponseEntity create(@RequestBody @Validated BlogDto blogDto, BindingResult result){
        //驗證字段
        if (bindResult.hasErrors()) {
            throw new BindingException(bindResult.getFieldError().getDefaultMessage());
        }
        //構建Model
        Blog blog = BeanUtils.copyProperties(blogDto,Blog.class);
        //todo 委託BlogService
        //todo 返回blog主鍵
        //todo 處理可能異常    
        return ResponseEntity.ok("");
    }
}

__Step5__:

@RestController
public class BlogController{

    @Autowired
    private BlogService blogService;

    //建立blog流程
    //接收參數
    @PostMapping("/blog")
    public ResponseEntity create(@RequestBody @Validated BlogDto blogDto, BindingResult result){
        //驗證字段
        if (bindResult.hasErrors()) {
            throw new BindingException(bindResult.getFieldError().getDefaultMessage());
        }
        //構建Model
        Blog blog = BeanUtils.copyProperties(blogDto,Blog.class);
        //委託BlogService
        Long recId = blogService.create(blog);
        //todo 返回blog主鍵
        //todo 處理可能異常    
        return ResponseEntity.ok("");
    }
}

@Service
public class BlogService{
    //建立blog
    public Long create(Blog blog){
        //todo 設置建立信息
        //todo 委託blogMapper執行
        //todo 返回主鍵
        return null;
    }
}

__Step6__:

@RestController
public class BlogController{

    @Autowired
    private BlogService blogService;

    //建立blog流程
    //接收參數
    @PostMapping("/blog")
    public ResponseEntity create(@RequestBody @Validated BlogDto blogDto, BindingResult result){
        //驗證字段
        if (bindResult.hasErrors()) {
            throw new BindingException(bindResult.getFieldError().getDefaultMessage());
        }
        //構建Model
        Blog blog = BeanUtils.copyProperties(blogDto,Blog.class);
        //委託BlogService
        Long recId = blogService.create(blog);
        //返回blog主鍵
        return ResponseEntity.ok(recId);
        //todo 處理可能異常    
    }
}

__Step7__:

@RestController
public class BlogController{

    @Autowired
    private BlogService blogService;

    //建立blog流程
    //接收參數
    @PostMapping("/blog")
    public ResponseEntity create(@RequestBody @Validated BlogDto blogDto, BindingResult result){
        try{
            //驗證字段
            if (bindResult.hasErrors()) {
                throw new BindingException(bindResult.getFieldError().getDefaultMessage());
            }
            //構建Model
            Blog blog = BeanUtils.copyProperties(blogDto,Blog.class);
            //委託BlogService
            Long recId = blogService.create(blog);
            //返回blog主鍵
            return ResponseEntity.ok(recId);
        }catch (BusinessException e) {
            //處理可能異常  
            logger.error("Create Blog Error!", e);
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                    .body("Create Blog Error!" + e.getMessage());
        } catch (Exception e) {
            logger.error("Create Blog Error!", e);
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                    .body("Create Blog Error!" + e.getMessage());
        }
    }
}

__Step8__:

@Service
public class BlogService{
    //建立blog
    public Long create(Blog blog){
        //設置建立信息
        Long userId = UserContext.getUser().getUserId();
        blog.setCreateId(userId);
        blog.setUpdateId(userId);
        blog.setCreateTime(new Date());
        blog.setUpdateTime(new Date());
        //todo 委託blogMapper執行
        //todo 返回主鍵
        return null;
    }
}

__Step9__:

@Service
public class BlogService{

    @Autowired
    private BlogMapper blogMapper;

    //建立blog
    public Long create(Blog blog){
        //設置建立信息
        Long userId = UserContext.getUser().getUserId();
        blog.setCreateId(userId);
        blog.setUpdateId(userId);
        blog.setCreateTime(new Date());
        blog.setUpdateTime(new Date());
        //委託blogMapper執行
        blogMapper.insert(blog);
        //todo 返回主鍵
        return null;
    }
}

__Step10__:

@Service
public class BlogService{

    @Autowired
    private BlogMapper blogMapper;

    //建立blog
    public Long create(Blog blog){
        //設置建立信息
        Long userId = UserContext.getUser().getUserId();
        blog.setCreateId(userId);
        blog.setUpdateId(userId);
        blog.setCreateTime(new Date());
        blog.setUpdateTime(new Date());
        //委託blogMapper執行
        blogMapper.insert(blog)
        //返回主鍵
        return blog.getRecId();
    }
}

前端開發流程

前端的開發除了須要處理代碼邏輯，還須要處理頁面流程！依然能夠以TODO的方式來處理，藉助於a標籤和按鈕，能夠把頁面流給串起來！
接着上面的Blog的CRUD邏輯，這裏僅列出示例，再也不演示流程，開發流程和上面的流程一致！

__list.html__:

<!-- todo 新增Blog-->
<a href="new.html">新增</a>

<!--TODO 搜索-->
<!--TODO 列表顯示，操做-->
<table>
    <tr>
        <td>
            <a href="view.html">查看</a>
            <a href="edit.html">編輯</a>
            <a href="delete.html">刪除</a>
        </td>
    </tr>
</table>
<!--TODO 翻頁-->

__new.html__:

<!--todo  表單字段-->
<!--todo  驗證規則-->
<!--todo 保存邏輯-->
<a href="list.html">保存按鈕</a>
<!--todo 取消邏輯-->
<a href="list.html">取消按鈕</a>

__view.html__:

<!--todo  展現字段-->
<!--todo 返回邏輯，按場景返回？-->
<a href="list.html">返回按鈕</a>

__edit.html__:

<!--todo  表單字段-->
<!--todo  字段賦值-->
<!--todo  驗證規則-->
<!--todo 保存邏輯-->
<a href="list.html">保存按鈕</a>
<!--todo 取消邏輯-->
<a href="list.html">取消按鈕</a>

優點

首先問一個問題，對於你接收到的信息，你是以什麼樣的標準來評判你理解了或學會了？就是__用你本身的話再說一遍__！
基於TODO的開發方法就是以此爲基礎：

• 首先基於需求，以TODO文字的形式將業務流程寫下來。寫下來之後，能夠和需求去確認，修正誤差，既__有助於理解需求__也__有助於梳理業務流程__
• 同時，能夠看出，每一個TODO的工做量都比較小，實際上也起到了__任務拆解和代碼封裝__的做用。既然任務拆解了，編寫的代碼也就相應的被拆解爲一個個的功能代碼了。固然對於邏輯較複雜的代碼，仍是須要使用重構手段，來進一步的對代碼進行封裝
• 代碼編寫完後，不須要將TODO徹底刪除，只須要把TODO字樣去除，__TODO就變成了註釋__了！
• 因爲每一個TODO的實現時間都較短（主要看拆解得如何），你開發的每一個小功能，實際上都是在解決一個TODO，就像遊戲裏的打怪同樣，能獲得__準即時反饋__，心理獲得知足！這是__進入心流體驗__的一個必要條件！

__關於心流體驗__：

• 心流英文叫"flow"，我第一次見到這個詞是在《人件》這本書上！這是兩年前寫的讀書筆記《個人管理實踐---《人件》讀後感》！
• 心流的解釋有不少，有興趣的能夠去搜索一下
• 相信不少人都經歷過，好比你作某件事時很專一（寫代碼、玩遊戲等等），當作完後，你覺得沒多長時間，可是回過神來一看，好幾個小時已通過去了！

寫在最後

本文只是演示了一種我的比較推崇的寫代碼的方式，並解釋了爲何推崇這種方式！固然，__僅供參考__！畢竟__適合本身的纔是最好的__！

---

公衆號：ivaneye