Ruim het afval op

TL;DR: Verwijder ongebruikte functies, constanten en code die u voor het geval dat nodig hebt.

Problemen aangepakt

• Dode code
• Voor-het-geval-code
• Verminderde onderhoudbaarheid
• Ankerboten
• Cognitieve belasting

Gerelateerde codegeuren

Stappen

1. Zorg ervoor dat uw code een goede functionele dekking heeft.
2. Identificeer ongebruikte functies en constanten door uw code te controleren of statische analysehulpmiddelen te gebruiken.
3. Analyseer voor de zekerheid de toegevoegde speculatieve code.
4. Verwijder alles wat overbodig of ongebruikt is.
5. Voer uitgebreide regressietests uit op uw code.

Voorbeeldcode

Voor

 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

Na

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

Type

• [x] Semi-automatisch

U kunt kleine stapjes zetten en de overbodige code in stappen verwijderen.

Veiligheid

Deze refactoring is veilig als u uw applicatie grondig test na de wijzigingen. Statische analysetools kunnen helpen ervoor te zorgen dat u niets verwijdert dat nog in gebruik is.

Waarom is de code beter?

U verbetert de duidelijkheid en vermindert de complexiteit door ongebruikte elementen te verwijderen.

Uw code wordt eenvoudiger te begrijpen en te onderhouden.

Door speculatieve code te beperken, blijft u zich concentreren op de huidige, werkelijke vereisten.

Hoe verbetert het de bijectie?

Dode code en speculatieve elementen verbreken de bijectie tussen uw software en het echte model.

Door deze elementen te verwijderen, zorgt u ervoor dat uw code uw MAPPER nauwkeurig weergeeft, waardoor deze schoner wordt en dichter bij de werkelijkheid komt.

Beperkingen

Om dode code te verwijderen, moet je er zeker van zijn dat deze daadwerkelijk niet wordt gebruikt.

Dit proces is afhankelijk van statische analyse of grondige kennis van de codebase. Zonder robuuste hulpmiddelen kan dit foutgevoelig zijn.

Refactoring met AI

Labels

• Opgeblazen

Verwante refactorings

Credits

Afbeelding door Peter H van Pixabay

Dit artikel is onderdeel van de Refactoring-serie.