Refactoring - Supprimer le code mort-Tutoriel Python-php.cn

Refactoring - Supprimer le code mort

Barbara Streisand

Libérer： 2024-12-29 17:34:11

original

654 Les gens l'ont consulté

Nettoyer les poubelles

TL;DR : éliminez les fonctions, constantes et codes « juste au cas » inutilisés.

Problèmes résolus

Code mort
Code juste au cas où
Maintenabilité réduite
Bateaux d'ancrage
Charge Cognitive

Odeurs de code associées

Code Odeur 09 - Code Mort

Maxi Contieri ・ 28 octobre 2020

#codenewbie #tutoriel

Code Odeur 54 - Bateaux à ancre

Maxi Contieri ・ 6 janvier 21

#codenewbie #webdev #tutoriel #code propre

Code Odeur 148 - ToDos

Maxi Contieri ・ 13 juillet 22

#javascript #webdev #débutants #programmation

Mesures

Assurez-vous que votre code a une bonne couverture fonctionnelle.
Identifiez les fonctions et constantes inutilisées en examinant votre code ou en utilisant des outils d'analyse statique.
Analysez le code spéculatif ajouté, juste au cas où.
Supprimez tout ce qui est inutile ou inutilisé.
Effectuez des tests de régression complets sur votre code.

Exemple de code

Avant

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

Copier après la connexion

Après

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

Copier après la connexion

Taper

[X] Semi-automatique

Sécurité

Cette refactorisation est sûre si vous testez minutieusement votre application après les modifications. Les outils d'analyse statique peuvent vous aider à garantir que vous ne supprimez rien encore en cours d'utilisation.

Pourquoi le code est-il meilleur ?

Vous améliorez la clarté et réduisez la complexité en supprimant les éléments inutilisés.

Votre code devient plus facile à comprendre et à maintenir.

Réduire le code spéculatif permet également de vous concentrer sur les exigences actuelles et réelles.

Comment améliore-t-il la bijection ?

Le code mort et les éléments spéculatifs brisent Bijection entre votre logiciel et le modèle du monde réel.

La suppression de ces éléments garantit que votre code représente avec précision votre
MAPPER, le rendant plus propre et plus proche de la réalité.

Limites

La suppression du code mort nécessite l'assurance qu'il est réellement inutilisé.

Ce processus repose sur une analyse statique ou une connaissance approfondie de la base de code, qui peut être sujette aux erreurs sans outils robustes.