清理垃圾

TL;DR：消除未使用的函數(shù)、常量和“以防萬一”代碼。

解決的問題

• 死代碼

• 以防萬一代碼

• 可維護(hù)性降低

• 錨船

• 認(rèn)知負(fù)荷

相關(guān)代碼異味

步驟

1. 確保您的代碼具有良好的功能覆蓋率。

2. 通過檢查代碼或使用靜態(tài)分析工具來識別未使用的函數(shù)和常量。

3. 分析添加的推測代碼，以防萬一。

4. 刪除任何不必要或未使用的內(nèi)容。

5. 對您的代碼執(zhí)行全面的回歸測試。

示例代碼

前

from flask import Flask, jsonify, make_response

app = Flask(__name__)

HTTP_100_CONTINUE = 100
HTTP_202_ACCEPTED = 202  # Not used
HTTP_204_NO_CONTENT = 204 # Not Used
HTTP_302_FOUND = 302 # Not Used
HTTP_400_BAD_REQUEST = 400  # Not Used
HTTP_401_UNAUTHORIZED = 401 # Not Used
HTTP_403_FORBIDDEN = 403
HTTP_404_NOT_FOUND = 404
HTTP_410_GONE = 410
HTTP_500_INTERNAL_SERVER_ERROR = 500
HTTP_501_NOT_IMPLEMENTED = 501

probe_telemetry = {
    "temperature": {"solar_panels": 150, "instrument_1": 50},
    "position": {"x": 1000000, "y": 2000000, "z": 3000000, 
    "velocity": {"vx": 100, "vy": 200, "vz": 300}},
    "status": {"power_level": 95, "communication_status": "OK"}
}

@app.route('/api/v1/probe/telemetry', methods=['GET'])
def get_telemetry():
    return jsonify(probe_telemetry), HTTP_200_OK

# The following function is not invoked 
# and not implemented
# It is a dead placeholder
@app.route('/api/v1/probe/send_command', methods=['POST'])
def send_command():
    return jsonify({"message": "Command endpoint not implemented yet."}), 
       HTTP_501_NOT_IMPLEMENTED

@app.route('/api/v1/probe/data', methods=['GET'])
def get_data():
    return jsonify({"message": "Data not found"}), 
       HTTP_404_NOT_FOUND

@app.route('/api/v1/probe/redirect', methods=['GET'])
def redirect_endpoint():
    response = make_response(jsonify({"message": "Redirecting..."}), 
       HTTP_301_MOVED_PERMANENTLY)
    response.headers['Location'] = '/api/v1/probe/telemetry'
    return response

@app.route('/api/v1/probe/not_modified', methods=['GET'])
def not_modified_endpoint():
    response = make_response(jsonify({"message": "Not Modified"}), 
       HTTP_304_NOT_MODIFIED)
    response.headers['ETag'] = 'some_etag'
    return response

@app.route('/api/v1/probe/gone', methods=['GET'])
def gone_endpoint():
    return jsonify({"message": "Resource permanently gone"}),
       HTTP_410_GONE

后

# 1. Ensure your code has good functional coverage.

from flask import Flask, jsonify, make_response
from http import HTTPStatus

app = Flask(__name__)

# 2. Identify unused functions and constants 
# by reviewing your code or using static analysis tools.
HTTP_200_OK = HTTPStatus.OK
HTTP_301_MOVED_PERMANENTLY = HTTPStatus.MOVED_PERMANENTLY
HTTP_304_NOT_MODIFIED = HTTPStatus.NOT_MODIFIED
HTTP_404_NOT_FOUND = HTTPStatus.NOT_FOUND
HTTP_410_GONE = HTTPStatus.GONE
HTTP_501_NOT_IMPLEMENTED = HTTPStatus.NOT_IMPLEMENTED

probe_telemetry = {
    "temperature": {"solar_panels": 150, "instrument_1": 50},
    "position": {"x": 1000000, "y": 2000000, "z": 3000000, 
    "velocity": {"vx": 100, "vy": 200, "vz": 300}},
    "status": {"power_level": 95, "communication_status": "OK"}
}

@app.route('/api/v1/probe/telemetry', methods=['GET'])
def get_telemetry():
    return jsonify(probe_telemetry), HTTP_200_OK

# 3. Analyze the added speculative code, just in case.

@app.route('/api/v1/probe/send_command', methods=['POST'])
def send_command():
    return jsonify({"message": "Command endpoint not implemented yet."}), 
       HTTP_501_NOT_IMPLEMENTED

@app.route('/api/v1/probe/data', methods=['GET'])
def get_data():
    return jsonify({"message": "Data not found"}), 
      HTTP_404_NOT_FOUND

# 4. Remove anything unnecessary or unused.

# 5. Perform comprehensive regression testing on your code.

類型

[X] 半自動

安全

如果您在更改后徹底測試您的應(yīng)用程序，則此重構(gòu)是安全的。靜態(tài)分析工具可以幫助確保您不會刪除仍在使用的任何內(nèi)容。

為什么代碼更好？

通過刪除未使用的元素可以提高清晰度并降低復(fù)雜性。

您的代碼變得更容易理解和維護(hù)。

減少推測性代碼還可以讓您專注于當(dāng)前的實(shí)際需求。

它如何改善雙射？

死代碼和推測元素會破壞軟件和現(xiàn)實(shí)世界模型之間的雙射。

刪除這些元素可確保您的代碼準(zhǔn)確地代表您的
MAPPER，使其更干凈、更接近現(xiàn)實(shí)。

局限性

刪除死代碼需要確信它確實(shí)未被使用。

此過程依賴于靜態(tài)分析或全面的代碼庫知識，如果沒有強(qiáng)大的工具，這可能很容易出錯。

用人工智能重構(gòu)

標(biāo)簽

• 浮腫

相關(guān)重構(gòu)

制作人員

該圖片由 Peter H 在 Pixabay上

---

本文是重構(gòu)系列的一部分。

以上是重構(gòu) - 刪除死代碼的詳細(xì)內(nèi)容。更多信息請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！