《编写可读代码的艺术》第10章 抽取不相关的子问题

    所谓工程学就是把大问题拆成小问题，再把这些问题的解决方案放回一起。把这条原则应用于代码会使代码更健壮且更易读。

    本章建议是：积极发现并抽取出不相关的子逻辑。

1. 纯工具代码

//C++中没有一个库函数读取整个文件，所以不可避免地要写以下的代码：
ifstream file(file_name);
// Calculate the file's size, and allocate a buffer of that size.
file.seekg(0, ios::end);
const int file_size = file.tellg();
char* file_buf = new char [file_size];
// Read the entire file into the buffer.
file.seekg(0, ios::beg);
file.read(file_buf, file_size);
file.close();

//这就是一个工具代码，应该抽取到一个新函数中（例如ReadFileToString）。
//经过一段时间，你会建立起一组不错的工具代码，可用于多个项目。

2. 其他多用途代码

ajax_post({
    url: 'http://example.com/submit',
    data: data,
    on_success: function (response_data) {
        var str = "{
";
        for (var key in response_data) {
            str += " " + key + " = " + response_data[key] + "
";
        }
        alert(str + "}");
        // Continue handling 'response_data' ...
    }
});

//从中抽取出format_pretty可以使代码使用更简单，更易读。
//同时，功能的修改或添加也更简单
var format_pretty = function (obj) {
    var str = "{
";
    for (var key in obj) {
        str += " " + key + " = " + obj[key] + "
";
    }
    return str + "}";
};

 3. 简化已有接口

var max_results;
var cookies = document.cookie.split(';');
for (var i = 0; i < cookies.length; i++) {
    var c = cookies[i];
    c = c.replace(/^[ ]+/, ''); // remove leading spaces
    if (c.indexOf("max_results=") === 0)
        max_results = Number(c.substring(12, c.length));
}

//创建一个新的函数get_cookie
var max_results = Number(get_cookie("max_results"));

4. 按需重塑接口

user_info = { "username": "...", "password": "..." }
user_str = json.dumps(user_info)
cipher = Cipher("aes_128_cbc", key=PRIVATE_KEY, init_vector=INIT_VECTOR, op=ENCODE)
encrypted_bytes = cipher.update(user_str)
encrypted_bytes += cipher.final() # flush out the current 128 bit block
url = "http://example.com/?user_info=" + base64.urlsafe_b64encode(encrypted_bytes)

#抽取出url_safe_encrypt
def url_safe_encrypt(obj):
    obj_str = json.dumps(obj)
    cipher = Cipher("aes_128_cbc", key=PRIVATE_KEY, init_vector=INIT_VECTOR, op=ENCODE)
    encrypted_bytes = cipher.update(obj_str)
    encrypted_bytes += cipher.final() # flush out the current 128 bit block
    return base64.urlsafe_b64encode(encrypted_bytes)

#真正的逻辑代码将变得非常简单
user_info = { "username": "...", "password": "..." }
url = "http://example.com/?user_info=" + url_safe_encrypt(user_info)

5. 过犹不及

#对于上面的代码可能可以进一步拆分，但是这么多小函数对可读性是不利的
#因为读者需要关注过多的东西，并且按照执行路径跳来跳去
#如果项目其他部分需要这些小函数，那么增加这些小函数是没问题的
def make_cipher():
    return Cipher("aes_128_cbc", key=PRIVATE_KEY, init_vector=INIT_VECTOR, op=ENCODE)

def encrypt(data):
    cipher = make_cipher()
    encrypted_bytes = cipher.update(data)
    encrypted_bytes += cipher.final() # flush out any remaining bytes
    return encrypted_bytes

def url_safe_encrypt_str(data):
    encrypted_bytes = encrypt(data)
    return base64.urlsafe_b64encode(encrypted_bytes)

def url_safe_encrypt_obj(obj):
    obj_str = json.dumps(obj)
    return url_safe_encrypt_str(obj_str)

user_info = { "username": "...", "password": "..." }
url = "http://example.com/?user_info=" + url_safe_encrypt_obj(user_info)

总结：把项目专有代码和一般代码（使之成为辅助函数）分开。