Хогоо цэвэрлэ

TL;DR: Ашиглагдаагүй функцууд, тогтмолууд болон "зөвхөн тохиолдлоор" кодыг устгана.

Шийдвэрлэсэн асуудлууд

• Үхсэн код
• Тохиолдлын код
• Засвар үйлчилгээ багассан
• Зангуу завь
• Танин мэдэхүйн ачаалал

Холбогдох кодын үнэр

Алхам

1. Таны код сайн функциональ хамрах хүрээтэй байгаа эсэхийг шалгаарай.
2. Кодоо шалгах эсвэл статик шинжилгээний хэрэгслүүдийг ашиглан ашиглагдаагүй функцууд болон тогтмолуудыг тодорхойл.
3. Нэмэлт таамаглалын кодыг шинжилж үзээрэй.
4. Шаардлагагүй эсвэл ашиглагдаагүй бүх зүйлийг устгана уу.
5. Код дээрээ иж бүрэн регрессийн тест хийнэ үү.

Жишээ код

Өмнө нь

 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] Хагас автомат

Та хүүхдийн алхмуудыг хийж, давталт дахь шаардлагагүй кодыг устгаж болно.

Аюулгүй байдал

Хэрэв та өөрчлөлт оруулсны дараа програмаа сайтар шалгаж үзсэн бол энэ рефакторинг аюулгүй болно. Статик шинжилгээний хэрэгслүүд нь одоог хүртэл ашиглагдаж байгаа зүйлийг устгахгүй байхад тусална.

Код яагаад илүү дээр вэ?

Ашиглагдаагүй элементүүдийг арилгах замаар та тодорхой байдлыг сайжруулж, нарийн төвөгтэй байдлыг багасгадаг.

Таны кодыг ойлгох, хадгалахад хялбар болно.

Таамаглалын кодыг багасгах нь одоогийн, бодит шаардлагад анхаарлаа төвлөрүүлдэг.

Энэ нь биеийг хэрхэн яаж сайжруулах вэ?

Үхсэн код болон таамаглалын элементүүд нь таны программ хангамж болон бодит загвар хоорондын Bijection-ийг эвддэг.

Эдгээр элементүүдийг устгаснаар код таны MAPPER-г үнэн зөв илэрхийлж, илүү цэвэр, бодит байдалд ойртуулна.

Хязгаарлалтууд

Үхсэн кодыг арилгахын тулд үүнийг үнэхээр ашиглаагүй гэдэгт итгэлтэй байх шаардлагатай.

Энэ үйл явц нь статик дүн шинжилгээ эсвэл кодын нарийн мэдлэгт тулгуурладаг бөгөөд энэ нь бат бөх хэрэгсэлгүйгээр алдаа гаргахад хялбар байдаг.

AI-тай рефактор

Шошго

• Гэдэс дүүрэгчид

Холбогдох рефакторууд

Зээл

Зургийг Pixabay -аас авсан Питер Х

Энэ нийтлэл нь Refactoring цувралын нэг хэсэг юм.