重構

開頭先抛出幾個問題吧，這幾個問題也是《重構：改善既有代碼的設計》這本書第2章的問題。

什麼是重構？

為什麼要重構？

什麼時候要重構？

接下來就從這幾個問題出發，通過這幾個問題來系統的了解重構的意義。

《重構：改善既有代碼的設計》這本書中将重構以名詞和動詞形式進行解釋，如下

重構（名詞）：對軟體内部結構的一種調整，目的是在不改變軟體可觀察行為的前提下，提高其可了解性，降低其修改成本。

重構（動詞）：使用一系列重構的手法，在不改變軟體可觀察行為的前提下，調整其結構。

然後作者又将定義往兩個方面擴充

重構的目的是使軟體更容易被了解和修改。
重構不會改變軟體可觀察的行為------重構之後軟體功能一如既往。

簡單來說就是

對編碼人員來說重構可以讓代碼可讀性變高，可擴充性變高，修改變得更容易。
對使用者來說重構不會影響原有的操作流程。

重構改進軟體設計
重構使軟體更容易了解
重構幫忙找到bug
重構提高程式設計速度

重構可以讓代碼變得結構化，利用設計模式對其合理的進行修改，使得代碼可讀性變高。如果代碼沒有進行重構，某些功能會變得越來越臃腫，将慢慢失去自己所應有的結構，而後續的人也會在上面添磚加瓦，使得程式越來越難以了解其含義。

關于何時重構，這本書中給出了幾點

事不過三，三則重構（當重複代碼超過三次，就應該重構）
添加功能時重構（代碼的設計無法幫助我輕松添加我所需要的特性）
修補錯誤時重構（可讀性不高，不能清晰快速的了解它）
複審代碼時重構（可以改善開發狀态，幫助了解軟體系統中的更多部分）

執行個體

這篇博文主要講述部落客将網上原有的execl導出功能代碼進行一步步的重構，設計成一個通用的、可擴充的代碼。

我們先來看看早期的代碼，如下

重構：以Java POI 導出EXCEL為例重構什麼是重構？為什麼要重構？什麼時候要重構？執行個體

public class ExportExcel<T> {
    public void exportExcel(Collection<T> dataset, OutputStream out) {
        exportExcel("測試POI導出EXCEL文檔", null, dataset, out, "yyyy-MM-dd");
    }

    public void exportExcel(String[] headers, Collection<T> dataset, OutputStream out) {
        exportExcel("測試POI導出EXCEL文檔", headers, dataset, out, "yyyy-MM-dd");
    }

    public void exportExcel(String[] headers, Collection<T> dataset, OutputStream out, String pattern) {
        exportExcel("測試POI導出EXCEL文檔", headers, dataset, out, pattern);
    }

    /**
     * 這是一個通用的方法，利用了JAVA的反射機制，可以将放置在JAVA集合中并且符号一定條件的資料以EXCEL 的形式輸出到指定IO裝置上
     * 
     * @param title
     *            表格标題名
     * @param headers
     *            表格屬性列名數組
     * @param dataset
     *            需要顯示的資料集合,集合中一定要放置符合javabean風格的類的對象。此方法支援的
     *            javabean屬性的資料類型有基本資料類型及String,Date,byte[](圖檔資料)
     * @param out
     *            與輸出裝置關聯的流對象，可以将EXCEL文檔導出到本地檔案或者網絡中
     * @param pattern
     *            如果有時間資料，設定輸出格式。預設為"yyy-MM-dd"
     */
    @SuppressWarnings("unchecked")
    public void exportExcel(String title, String[] headers, Collection<T> dataset, OutputStream out, String pattern) {
        // 聲明一個工作薄
        HSSFWorkbook workbook = new HSSFWorkbook();
        // 生成一個表格
        HSSFSheet sheet = workbook.createSheet(title);
        // 設定表格預設列寬度為15個位元組
        sheet.setDefaultColumnWidth((short) 15);
        // 生成一個樣式
        HSSFCellStyle style = workbook.createCellStyle();
        // 設定這些樣式
        style.setFillForegroundColor(HSSFColor.SKY_BLUE.index);
        style.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND);
        style.setBorderBottom(HSSFCellStyle.BORDER_THIN);
        style.setBorderLeft(HSSFCellStyle.BORDER_THIN);
        style.setBorderRight(HSSFCellStyle.BORDER_THIN);
        style.setBorderTop(HSSFCellStyle.BORDER_THIN);
        style.setAlignment(HSSFCellStyle.ALIGN_CENTER);
        // 生成一個字型
        HSSFFont font = workbook.createFont();
        font.setColor(HSSFColor.VIOLET.index);
        font.setFontHeightInPoints((short) 12);
        font.setBoldweight(HSSFFont.BOLDWEIGHT_BOLD);
        // 把字型應用到目前的樣式
        style.setFont(font);
        // 生成并設定另一個樣式
        HSSFCellStyle style2 = workbook.createCellStyle();
        style2.setFillForegroundColor(HSSFColor.LIGHT_YELLOW.index);
        style2.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND);
        style2.setBorderBottom(HSSFCellStyle.BORDER_THIN);
        style2.setBorderLeft(HSSFCellStyle.BORDER_THIN);
        style2.setBorderRight(HSSFCellStyle.BORDER_THIN);
        style2.setBorderTop(HSSFCellStyle.BORDER_THIN);
        style2.setAlignment(HSSFCellStyle.ALIGN_CENTER);
        style2.setVerticalAlignment(HSSFCellStyle.VERTICAL_CENTER);
        // 生成另一個字型
        HSSFFont font2 = workbook.createFont();
        font2.setBoldweight(HSSFFont.BOLDWEIGHT_NORMAL);
        // 把字型應用到目前的樣式
        style2.setFont(font2);

        // 聲明一個畫圖的頂級管理器
        HSSFPatriarch patriarch = sheet.createDrawingPatriarch();
        // 定義注釋的大小和位置,詳見文檔
        HSSFComment comment = patriarch.createComment(new HSSFClientAnchor(0, 0, 0, 0, (short) 4, 2, (short) 6, 5));
        // 設定注釋内容
        comment.setString(new HSSFRichTextString("可以在POI中添加注釋！"));
        // 設定注釋作者，當滑鼠移動到單元格上是可以在狀态欄中看到該内容.
        comment.setAuthor("leno");

        // 産生表格标題行
        HSSFRow row = sheet.createRow(0);
        for (short i = 0; i < headers.length; i++) {
            HSSFCell cell = row.createCell(i);
            cell.setCellStyle(style);
            HSSFRichTextString text = new HSSFRichTextString(headers[i]);
            cell.setCellValue(text);
        }

        // 周遊集合資料，産生資料行
        Iterator<T> it = dataset.iterator();
        int index = 0;
        while (it.hasNext()) {
            index++;
            row = sheet.createRow(index);
            T t = (T) it.next();
            // 利用反射，根據javabean屬性的先後順序，動态調用getXxx()方法得到屬性值
            Field[] fields = t.getClass().getDeclaredFields();
            for (short i = 0; i < fields.length; i++) {
                HSSFCell cell = row.createCell(i);
                cell.setCellStyle(style2);
                Field field = fields[i];
                String fieldName = field.getName();
                String getMethodName = "get" + fieldName.substring(0, 1).toUpperCase() + fieldName.substring(1);
                try {
                    Class tCls = t.getClass();
                    Method getMethod = tCls.getMethod(getMethodName, new Class[] {});
                    Object value = getMethod.invoke(t, new Object[] {});
                    // 判斷值的類型後進行強制類型轉換
                    String textValue = null;
                    // if (value instanceof Integer) {
                    // int intValue = (Integer) value;
                    // cell.setCellValue(intValue);
                    // } else if (value instanceof Float) {
                    // float fValue = (Float) value;
                    // textValue = new HSSFRichTextString(
                    // String.valueOf(fValue));
                    // cell.setCellValue(textValue);
                    // } else if (value instanceof Double) {
                    // double dValue = (Double) value;
                    // textValue = new HSSFRichTextString(
                    // String.valueOf(dValue));
                    // cell.setCellValue(textValue);
                    // } else if (value instanceof Long) {
                    // long longValue = (Long) value;
                    // cell.setCellValue(longValue);
                    // }
                    if (value instanceof Boolean) {
                        boolean bValue = (Boolean) value;
                        textValue = "男";
                        if (!bValue) {
                            textValue = "女";
                        }
                    } else if (value instanceof Date) {
                        Date date = (Date) value;
                        SimpleDateFormat sdf = new SimpleDateFormat(pattern);
                        textValue = sdf.format(date);
                    } else if (value instanceof byte[]) {
                        // 有圖檔時，設定行高為60px;
                        row.setHeightInPoints(60);
                        // 設定圖檔所在列寬度為80px,注意這裡機關的一個換算
                        sheet.setColumnWidth(i, (short) (35.7 * 80));
                        // sheet.autoSizeColumn(i);
                        byte[] bsValue = (byte[]) value;
                        HSSFClientAnchor anchor = new HSSFClientAnchor(0, 0, 1023, 255, (short) 6, index, (short) 6,
                                index);
                        anchor.setAnchorType(2);
                        patriarch.createPicture(anchor, workbook.addPicture(bsValue, HSSFWorkbook.PICTURE_TYPE_JPEG));
                    } else {
                        // 其它資料類型都當作字元串簡單處理
                        textValue = value.toString();
                    }
                    // 如果不是圖檔資料，就利用正規表達式判斷textValue是否全部由數字組成
                    if (textValue != null) {
                        Pattern p = Pattern.compile("^//d+(//.//d+)?$");
                        Matcher matcher = p.matcher(textValue);
                        if (matcher.matches()) {
                            // 是數字當作double處理
                            cell.setCellValue(Double.parseDouble(textValue));
                        } else {
                            HSSFRichTextString richString = new HSSFRichTextString(textValue);
                            HSSFFont font3 = workbook.createFont();
                            font3.setColor(HSSFColor.BLUE.index);
                            richString.applyFont(font3);
                            cell.setCellValue(richString);
                        }
                    }
                } catch (SecurityException e) {
                    e.printStackTrace();
                } catch (NoSuchMethodException e) {
                    e.printStackTrace();
                } catch (IllegalArgumentException e) {
                    e.printStackTrace();
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                } catch (InvocationTargetException e) {
                    e.printStackTrace();
                } finally {
                    // 清理資源
                }
            }
        }
        try {
            workbook.write(out);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public static void main(String[] args) {
        // 測試學生
        ExportExcel<Student> ex = new ExportExcel<Student>();
        String[] headers = { "學号", "姓名", "年齡", "性别", "出生日期" };
        List<Student> dataset = new ArrayList<Student>();
        dataset.add(new Student(10000001, "張三", 20, true, new Date()));
        dataset.add(new Student(20000002, "李四", 24, false, new Date()));
        dataset.add(new Student(30000003, "王五", 22, true, new Date()));
        // 測試圖書
        ExportExcel<Book> ex2 = new ExportExcel<Book>();
        String[] headers2 = { "圖書編号", "圖書名稱", "圖書作者", "圖書價格", "圖書ISBN", "圖書出版社", "封面圖檔" };
        List<Book> dataset2 = new ArrayList<Book>();
        try {
            BufferedInputStream bis = new BufferedInputStream(new FileInputStream("D://USER//Desktop//1.jpg"));
            byte[] buf = new byte[bis.available()];
            while ((bis.read(buf)) != -1) {
                //
            }
            dataset2.add(new Book(1, "jsp", "leno", 300.33f, "1234567", "清華出版社", buf));
            dataset2.add(new Book(2, "java程式設計思想", "brucl", 300.33f, "1234567", "陽光出版社", buf));
            dataset2.add(new Book(3, "DOM藝術", "lenotang", 300.33f, "1234567", "清華出版社", buf));
            dataset2.add(new Book(4, "c++經典", "leno", 400.33f, "1234567", "清華出版社", buf));
            dataset2.add(new Book(5, "c#入門", "leno", 300.33f, "1234567", "湯春秀出版社", buf));

            OutputStream out = new FileOutputStream("E://a.xls");
            OutputStream out2 = new FileOutputStream("E://b.xls");
            ex.exportExcel(headers, dataset, out);
            ex2.exportExcel(headers2, dataset2, out2);
            out.close();
            out2.close();
            JOptionPane.showMessageDialog(null, "導出成功!");
            System.out.println("excel導出成功！");
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

View Code

這邊将整個導出功能都放在一個類裡面，這樣代碼修改起來不容易。

接下來我們先來提煉函數（Extract Method）

上述代碼中的導出流程大緻上可以分為五個步驟，如下

建立一系列的對象（workbook、sheet...）
建立樣式、字型
産生表格标題行
周遊集合資料，産生資料行
寫入io流

那麼我們就可以按照這幾個流程，将他們封裝成方法，一些對象可以修改才類的成員變量

開始重構

1.建立一系列的對象（workbook、sheet...）

之前的代碼

重構：以Java POI 導出EXCEL為例重構什麼是重構？為什麼要重構？什麼時候要重構？執行個體

// 聲明一個工作薄
HSSFWorkbook workbook = new HSSFWorkbook();

将workbook修改成成員變量，在構造函數時初始化它

private HSSFWorkbook workbook;
    
    public ExportExcel() {
        this(new HSSFWorkbook());
    }

    public ExportExcel(HSSFWorkbook workbook) {
        this.workbook = workbook;
    }

2.建立樣式、字型

之前的代碼

重構：以Java POI 導出EXCEL為例重構什麼是重構？為什麼要重構？什麼時候要重構？執行個體

// 生成一個樣式
        HSSFCellStyle style = workbook.createCellStyle();
        // 設定這些樣式
        style.setFillForegroundColor(HSSFColor.SKY_BLUE.index);
        style.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND);
        style.setBorderBottom(HSSFCellStyle.BORDER_THIN);
        style.setBorderLeft(HSSFCellStyle.BORDER_THIN);
        style.setBorderRight(HSSFCellStyle.BORDER_THIN);
        style.setBorderTop(HSSFCellStyle.BORDER_THIN);
        style.setAlignment(HSSFCellStyle.ALIGN_CENTER);
        // 生成一個字型
        HSSFFont font = workbook.createFont();
        font.setColor(HSSFColor.VIOLET.index);
        font.setFontHeightInPoints((short) 12);
        font.setBoldweight(HSSFFont.BOLDWEIGHT_BOLD);
        // 把字型應用到目前的樣式
        style.setFont(font);
        // 生成并設定另一個樣式
        HSSFCellStyle style2 = workbook.createCellStyle();
        style2.setFillForegroundColor(HSSFColor.LIGHT_YELLOW.index);
        style2.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND);
        style2.setBorderBottom(HSSFCellStyle.BORDER_THIN);
        style2.setBorderLeft(HSSFCellStyle.BORDER_THIN);
        style2.setBorderRight(HSSFCellStyle.BORDER_THIN);
        style2.setBorderTop(HSSFCellStyle.BORDER_THIN);
        style2.setAlignment(HSSFCellStyle.ALIGN_CENTER);
        style2.setVerticalAlignment(HSSFCellStyle.VERTICAL_CENTER);
        // 生成另一個字型
        HSSFFont font2 = workbook.createFont();
        font2.setBoldweight(HSSFFont.BOLDWEIGHT_NORMAL);
        // 把字型應用到目前的樣式
        style2.setFont(font2);

将建立兩個樣式代碼提煉成兩個函數，資料标題樣式方法getRowTitleStyle和資料行樣式方法getRowDataStyle

重構：以Java POI 導出EXCEL為例重構什麼是重構？為什麼要重構？什麼時候要重構？執行個體

/**
     * Description:生成資料标題樣式
     */
    private HSSFCellStyle getRowTitleStyle() {
        HSSFCellStyle style = workbook.createCellStyle();
        // 設定這些樣式
        style.setFillForegroundColor(HSSFColor.SKY_BLUE.index);
        style.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND);
        style.setBorderBottom(HSSFCellStyle.BORDER_THIN);
        style.setBorderLeft(HSSFCellStyle.BORDER_THIN);
        style.setBorderRight(HSSFCellStyle.BORDER_THIN);
        style.setBorderTop(HSSFCellStyle.BORDER_THIN);
        style.setAlignment(HSSFCellStyle.ALIGN_CENTER);
        
        // 生成一個字型
        HSSFFont font = workbook.createFont();
        font.setColor(HSSFColor.VIOLET.index);
        font.setFontHeightInPoints((short) 12);
        font.setBoldweight(HSSFFont.BOLDWEIGHT_BOLD);
        
        // 把字型應用到目前的樣式
        style.setFont(font);
        
        return style;
    }
    
    /**
     * Description:生成資料行樣式
     */
    private HSSFCellStyle getRowDataStyle() {
        HSSFCellStyle style = workbook.createCellStyle();
        // 設定這些樣式
        style.setFillForegroundColor(HSSFColor.SKY_BLUE.index);
        style.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND);
        style.setBorderBottom(HSSFCellStyle.BORDER_THIN);
        style.setBorderLeft(HSSFCellStyle.BORDER_THIN);
        style.setBorderRight(HSSFCellStyle.BORDER_THIN);
        style.setBorderTop(HSSFCellStyle.BORDER_THIN);
        style.setAlignment(HSSFCellStyle.ALIGN_CENTER);
        style.setVerticalAlignment(HSSFCellStyle.VERTICAL_CENTER);
        
        // 生成另一個字型
        HSSFFont font = workbook.createFont();
        font.setBoldweight(HSSFFont.BOLDWEIGHT_NORMAL);
        
        style.setFont(font);
                
        return style;
    }

3、4、5.産生表格标題行、周遊集合資料，産生資料行、寫入io流

// 産生表格标題行
        HSSFRow row = sheet.createRow(0);
        for (short i = 0; i < headers.length; i++) {
            HSSFCell cell = row.createCell(i);
            cell.setCellStyle(style);
            HSSFRichTextString text = new HSSFRichTextString(headers[i]);
            cell.setCellValue(text);
        }

将上面産生表格标題行代碼塊提煉成方法，産生資料行和寫入io流也是如此。代碼就不貼了

提煉後的主方法

public void exportExcel(String title, String[] headers, Collection<T> dataset, OutputStream out, String pattern) {
        // 生成一個表格
        HSSFSheet sheet = workbook.createSheet(title);
        
        // 生成資料标題和資料行樣式
        HSSFCellStyle rowTirtleStyle = getRowTitleStyle();
        HSSFCellStyle rowDataStyle = getRowDataStyle();
        
        //建立資料标題和資料行
        createRowTitle(headers, sheet, rowTirtleStyle);
        createRowData(dataset, pattern, sheet, rowDataStyle);
        
        //寫入流
        writeExecl(out);
    }

提煉後是不是精簡了許多，好了，這篇博文暫時就介紹一種重構方式--提煉函數。

後續博文會繼續對Java POI 導出EXCEL進行重構

将一些重複代碼替換成已有的工具類中的代碼

将一些方法提煉成類

将資料封裝成對象

等等

覺得不錯的可以關注我哦

github位址在這

，後續會增加其他各種各樣的工具項目，覺得不錯的點個star

作者：雲枭zd

Github：

Github位址

出處：

https://www.cnblogs.com/fixzd/

重構：以Java POI 導出EXCEL為例重構什麼是重構？為什麼要重構？什麼時候要重構？執行個體

重構

執行個體

開始重構

1.建立一系列的對象（workbook、sheet...）

2.建立樣式、字型

3、4、5.産生表格标題行、周遊集合資料，産生資料行、寫入io流

提煉後的主方法

繼續閱讀

适用于JavaScript的ECMAScript 2020規範向前發展

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

JS生成uuid的四種方法

線性表之順序表的實作

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Effective Java 8:通用程式設計

C++判斷素數、求最大公約數代碼判斷一個數是否為素數求兩個數的最大公約數

SequoiaDB巨杉資料庫C++驅動概述

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

layui多任務上傳添加進度條

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method