paint-brush
Reactoring 021 - យក Dead Codeដោយ@mcsee
ប្រវត្តិសាស្ត្រថ្មី។

Reactoring 021 - យក Dead Code

ដោយ Maximiliano Contieri4m2025/01/01
Read on Terminal Reader

យូរ​ពេក; អាន

លុបបំបាត់មុខងារដែលមិនប្រើ លេខថេរ និងកូដ "គ្រាន់តែក្នុងករណី" ។
featured image - Reactoring 021 - យក Dead Code
Maximiliano Contieri HackerNoon profile picture
0-item

សម្អាតធុងសំរាម

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 យ៉ាងដូចម្តេច?

កូដស្លាប់ និងធាតុប៉ាន់ស្មានបំបែក Bijection រវាងកម្មវិធីរបស់អ្នក និងគំរូពិភពពិត។

ការដកធាតុទាំងនេះធានាថាលេខកូដរបស់អ្នកតំណាងឱ្យ MAPPER របស់អ្នកយ៉ាងត្រឹមត្រូវ ធ្វើឱ្យវាកាន់តែស្អាត និងកាន់តែខិតទៅជិតការពិត។

ដែនកំណត់

ការដកលេខកូដដែលស្លាប់ចេញ ទាមទារទំនុកចិត្តថាវាពិតជាមិនបានប្រើ។

ដំណើរការនេះពឹងផ្អែកលើការវិភាគឋិតិវន្ត ឬចំណេះដឹងអំពីមូលដ្ឋានកូដយ៉ាងម៉ត់ចត់ ដែលអាចមានកំហុសដោយគ្មានឧបករណ៍រឹងមាំ។

Reactor ជាមួយ AI

ដោយគ្មានការណែនាំត្រឹមត្រូវ។

ជាមួយនឹងការណែនាំជាក់លាក់

ChatGPT

ChatGPT

ក្លូដ

ក្លូដ

ភាពច្របូកច្របល់

ភាពច្របូកច្របល់

កូពីឡុត

កូពីឡុត

Gemini

Gemini

ស្លាក

  • អ្នកហើមពោះ

ការកែលម្អដែលពាក់ព័ន្ធ

ឥណទាន

រូបថតរបស់ Peter H ពី Pixabay


អត្ថបទនេះគឺជាផ្នែកមួយនៃស៊េរី Refactoring ។


L O A D I N G
. . . comments & more!

About Author

Maximiliano Contieri HackerNoon profile picture
Maximiliano Contieri@mcsee
I’m a sr software engineer specialized in Clean Code, Design and TDD Book "Clean Code Cookbook" 500+ articles written

ព្យួរស្លាក

អត្ថបទនេះត្រូវបានបង្ហាញនៅក្នុង...