Vyčistite odpadky

TL;DR: Eliminujte nepoužívané funkcie, konštanty a kód typu „just-in-case“.

Problémy vyriešené

• Mŕtvy kódex
• Kód pre prípad
• Znížená udržiavateľnosť
• Kotvové člny
• Kognitívna záťaž

Súvisiaci kód zapácha

Kroky

1. Uistite sa, že váš kód má dobré funkčné pokrytie.
2. Identifikujte nepoužívané funkcie a konštanty kontrolou kódu alebo pomocou nástrojov na statickú analýzu.
3. Pre každý prípad analyzujte pridaný špekulatívny kód.
4. Odstráňte všetko nepotrebné alebo nepoužívané.
5. Vykonajte komplexné regresné testovanie svojho kódu.

Vzorový kód

Predtým

 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

Po

 # 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] Poloautomatický

Môžete vykonávať detské kroky a odstraňovať nepotrebný kód v iteráciách.

Bezpečnosť

Tento refaktoring je bezpečný, ak svoju aplikáciu po zmenách dôkladne otestujete. Nástroje na statickú analýzu vám môžu pomôcť zabezpečiť, aby ste neodstránili nič, čo sa stále používa.

Prečo je kód lepší?

Zlepšíte prehľadnosť a znížite zložitosť odstránením nepoužitých prvkov.

Váš kód bude ľahšie pochopiteľný a udržiavateľný.

Zníženie špekulatívneho kódu tiež udrží vaše zameranie na aktuálne, skutočné požiadavky.

Ako to zlepšuje bijekciu?

Mŕtvy kód a špekulatívne prvky narušujú prepojenie medzi vaším softvérom a modelom v reálnom svete.

Odstránenie týchto prvkov zaistí, že váš kód bude presne reprezentovať váš MAPPER , vďaka čomu bude čistejší a bližšie k realite.

Obmedzenia

Odstránenie mŕtveho kódu vyžaduje istotu, že sa skutočne nepoužíva.

Tento proces sa spolieha na statickú analýzu alebo dôkladnú znalosť kódovej základne, ktorá môže byť bez robustných nástrojov náchylná na chyby.

Refaktor s AI

Tagy

• Nafukovači

Súvisiace refaktorizácie

Kredity

Obrázok Peter H z Pixabay

Tento článok je súčasťou série Refaktoring.