จัดการโค้ดก่อนส่งขึ้น Git Repository ด้วย VCS ใน Android Studio
การจัดการโค้ดให้เป็นระเบียบนั้นเป็นสิ่งที่ไม่ควรมองข้ามเพราะโค้ดที่เป็นระเบียบนั้นจะช่วยให้คนอ่านสามารถทำความเข้าใจกับโค้ดได้ง่าย รวมถึงทำให้โค้ดมีคุณภาพมากขึ้น
สำหรับนักพัฒนาแอพฯ Android แล้วคงจะคุ้นตากับเจ้าเมนูที่ชื่อว่า VCS (Version Control System) กันเป็นอย่างดีเพราะมันแสดงอยู่บนท็อปเมนูของ Android Studio เลยถ้าหากไม่เคยใช้ก็ต้องเห็นผ่านๆตากันบ้างแหละ
พอกดเข้าไปปุ๊บก็จะพบว่า…มันก็คือ GIT GUI ดีๆนี่เอง
บทความนี้จะไม่พูดถึงว่า GIT GUI มันคืออะไรดังนั้นจะขอข้ามไปเลยละกัน(หุๆ) จากหัวข้อข้างบนทุกคนคงจะสงสัยแล้วหละว่าแล้วเราจะใช้เจ้า VCS นี้ตรวจสอบและจัดการโค้ดให้มันเป็นระเบียบได้ยังไงกันนะ
มาเริ่มกันเถอะ
หลังจากที่บรรจงเขียนโค้ดเสร็จเรียบร้อยแล้วก่อนจะ push โค้ดได้ก็ต้อง commit มันก่อน(คลิ๊กขวา GIT => Commit หรือ VCS => Commit)
สังเกตุตรง Before commit กันไหมจะเห็นว่ามี check box อยู่ 7 ตัว
ซึ่งตัวเลือกพวกนี่แหละที่จะช่วยเราตรวจสอบและจัดการความเรียบร้อยของโค้ดได้
ปกติแล้วจะมี default selected มาให้สองอย่างคือ Perform code analysis กับ Check TODO แต่ที่จะยกมาพูดในบทความนี้จะมีอยู่ 5 อย่างคือ
1. Reformat code: ทำการจัดรูปแบบโค้ดใหม่ตาม style ที่กำหนดไว้
2. Rearrange code: ทำการจัดเรียง method และ property ใหม่ตามที่กำหนดไว้
3. Optimize imports: ทำการปรับหรือลบ import ที่ไม่ได้ถูกใช้งาน
4. Perform code analysis: ทำการวิเคราะห์โค้ดและตรวจสอบโค้ด
5. Cleanup: ทำการลบโค้ดส่วนที่ไม่จำเป็นทิ้ง
เมื่อทำการเลือกทั้ง 5 ข้อแล้วก็ทำการกด Commit หลังจากนั้นจะมี code analysis dialog แจ้งตือนขึ้นมาแบบนี้ โดยจะบอกว่าโค้ดของเรามี error หรือ warning กี่จุด
ถ้าหากมี error หรือ warning ก็กด Review ดูสักหน่อย(ใครไม่ยอมกดให้ตีมือตัวเองแรงๆ ถ้าไม่มีก็กด commit ได้เลย) ผลลัพธ์จากการ analysis จะบอกว่าโค้ดเรามี error ตรงจุดไหนหรือมีจุดไหนบ้างที่ควรแก้ ตรงนี้ถ้ามี warning ก็ควรจัดการให้เสร็จเรียบร้อยก่อนนะ ถึงแม้บาง warning มันไม่ได้ส่งผลต่อการทำงานของแอพฯก็ตาม แต่เพื่อสุขภาพที่ดีของโค้ดก็ต้องแก้มันซะ
หลังจากทำการแก้ error และจัดการ warning แล้ว ก็ทำการกด commit อีกรอบลองเลื่อนลงมาดู diff จะพบว่าโค้ดมีการจัด format ใหม่และมีการปรับ/ลบ import บางตัวที่ไม่ได้ใช้ออกไป เพียงเท่านี้โค้ดของเราก็พร้อมถูกส่งขึ้น GIT Repository แล้ว
ปล. ไม่มีตัวอย่างการ cleanup กับ rearrange ให้ดูลองไปทำดูกันเองนะ แหะๆ
จบแล้ว…สำหรับการตรวจสอบและจัดการโค้ดก่อนส่งขึ้น Git Repository
สรุป
การจัดการให้โค้ดให้เป็นระเบียบนั้นเป็นเรื่องที่สำคัญเรื่องหนึ่งเลยที่ developer ไม่ควรมองข้ามเพราะการเขียนโค้ดที่ไม่เป็นระเบียบ ย่อมส่งผลถึงคุณภาพของโค้ดและมีผลเสียตามมาแน่นอนซึ่งอาจจะไม่ส่งผลในระยะสั้น แต่อาจส่งผลในระยะยาวและควรคำนึงว่าตัว VCS ช่วยได้แค่เพียงส่วนหนึ่งเท่านั้น developer เองควรฝึกการเขียนโค้ดให้มีระเบียบและคุณภาพที่ดีเพื่อประโยชน์ต่อตัวเองและคนที่จะมาพัฒนาโค้ดต่อจากเรา
