Refactoring – Entfernen Sie toten Code

Räum den Müll auf

TL;DR: Eliminieren Sie ungenutzte Funktionen, Konstanten und „nur für den Fall“-Code.

Behandelte Probleme

• Toter Code

• Code für den Fall der Fälle

• Reduzierte Wartbarkeit

• Ankerboote

• Kognitive Belastung

Verwandte Code-Smells

Code Smell 09 – Toter Code

Maxi Contieri ・ 28. Okt. 2020

#codenewbie #tutorial

Code Smell 54 – Ankerboote

Maxi Contieri ・ 6. Januar 21

#codenewbie #webdev #tutorial #cleancode

Code Smell 148 – ToDos

Maxi Contieri ・ 13. Juli '22

#javascript #webdev #Anfänger #Programmierung

Schritte

1. Stellen Sie sicher, dass Ihr Code über eine gute Funktionsabdeckung verfügt.

2. Identifizieren Sie nicht verwendete Funktionen und Konstanten, indem Sie Ihren Code überprüfen oder statische Analysetools verwenden.

3. Analysieren Sie den hinzugefügten spekulativen Code für alle Fälle.

4. Entfernen Sie alles Unnötige oder Unbenutzte.

5. Führen Sie umfassende Regressionstests für Ihren Code durch.

Beispielcode

Vor

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

Nach

# 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.

Typ

[X] Halbautomatisch

Sicherheit

Dieses Refactoring ist sicher, wenn Sie Ihre Anwendung nach den Änderungen gründlich testen. Statische Analysetools können dabei helfen, sicherzustellen, dass Sie nichts entfernen, was noch verwendet wird.

Warum ist der Kodex besser?

Sie verbessern die Übersichtlichkeit und reduzieren die Komplexität, indem Sie nicht verwendete Elemente entfernen.

Ihr Code wird einfacher zu verstehen und zu warten.

Durch die Reduzierung spekulativen Codes bleibt Ihr Fokus auch auf aktuellen, tatsächlichen Anforderungen.

Wie verbessert es die Bijektion?

Toter Code und spekulative Elemente unterbrechen die Bijektion zwischen Ihrer Software und dem realen Modell.

Durch das Entfernen dieser Elemente wird sichergestellt, dass Ihr Code Ihr
genau wiedergibt MAPPER macht es sauberer und näher an der Realität.

Einschränkungen

Das Entfernen von totem Code erfordert die Gewissheit, dass er wirklich ungenutzt ist.

Dieser Prozess basiert auf statischer Analyse oder gründlichen Codebasiskenntnissen, die ohne robuste Tools fehleranfällig sein können.

Refactoring mit KI

Without Proper Instructions	With Specific Instructions
ChatGPT	ChatGPT
Claude	Claude
Perplexity	Perplexity
Copilot	Copilot
Gemini	Gemini

Schlagworte

• Aufbläher

Verwandte Refactorings

Refactoring 003 – Konstante extrahieren

Maxi Contieri ・ 2. Jan. '22

#oop #Programmierung #Refactoring #cleancode

Credits

Bild von Peter H von Pixabay

---

Dieser Artikel ist Teil der Refactoring-Reihe.

So verbessern Sie Ihren Code mit einfachen Refactorings

Maxi Contieri ・ 24. Okt. 22

#webdev #Anfänger #Programmierung #tutorial

Das obige ist der detaillierte Inhalt vonRefactoring – Entfernen Sie toten Code. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!