การแยกวิเคราะห์ไฟล์ทั่วไปใน Java โดยใช้รูปแบบกลยุทธ์

ฉันกำลังทำงานกับผลิตภัณฑ์ที่ความรับผิดชอบของหนึ่งในโมดูลคือการแยกวิเคราะห์ไฟล์ XML และถ่ายโอนเนื้อหาที่ต้องการในฐานข้อมูล แม้ว่าความต้องการในปัจจุบันจะเป็นเพียงการแยกวิเคราะห์ไฟล์ XML แต่ฉันต้องการออกแบบโมดูลการแยกวิเคราะห์ในแบบที่ฉันสามารถรองรับไฟล์ประเภทใดก็ได้ในอนาคต เหตุผลสำหรับวิธีนี้คือเรากำลังสร้างผลิตภัณฑ์นี้สำหรับลูกค้าเฉพาะ แต่วางแผนที่จะขายให้กับลูกค้ารายอื่นในอนาคตอันใกล้ ระบบทั้งหมดในระบบนิเวศสำหรับลูกค้าปัจจุบันผลิตและใช้ไฟล์ XML แต่นี่อาจไม่เป็นกรณีสำหรับลูกค้ารายอื่น

ฉันพยายามทำอะไรจนถึงตอนนี้? (ปัจจุบัน) ฉันมีการออกแบบต่อไปนี้ในใจซึ่งขึ้นอยู่กับรูปแบบกลยุทธ์ ฉันได้เขียนรหัสลงในคราสอย่างรวดเร็วเพื่อถ่ายทอดการออกแบบของฉันดังนั้นมันจะดีมากหากแง่มุมอื่น ๆ เช่นวิธีการที่เหมาะสมในการจัดการข้อยกเว้นถูกละเว้นในตอนนี้

Parser:อินเตอร์เฟสกลยุทธ์ที่แสดงเมธอดการวิเคราะห์

 public interface Parser<T> {
        public T parse(String inputFile);
    }

* เหตุผลในการใช้พารามิเตอร์ทั่วไปคืออนุญาตประเภทการส่งคืนใด ๆ รวมถึงความปลอดภัยของประเภทในเวลารวบรวม

ProductDataXmlParserคลาสที่เป็นรูปธรรมสำหรับการวิเคราะห์ไฟล์ product.xml ที่มีข้อมูลที่เกี่ยวข้องกับผลิตภัณฑ์ (ใช้ XMLBeans)

public class ProductDataXmlParser implements Parser<ProductDataTYPE> {

    public ProductDataTYPE parse(String inputFile) {
        ProductDataTYPE productDataDoc = null;
            File inputXMLFile = new File(inputFile);

        try {
            productDataDoc = ProductDataDocument.Factory.parse(inputXMLFile);
        } catch(XmlException e) {
            System.out.println("XmlException while parsing file : "+inputXMLFile);
        } catch(IOException e) { 
                 System.out.println("IOException while parsing file : "+inputXMLFile);
        }
        return productDataDoc.getProductData();
    }
} 

โดยที่ ProductDataTYPE และ ProductDataDocument เป็นคลาส XMlBean POJO ที่สร้างขึ้นโดยใช้คำสั่ง xsd และ scomp

อนาคต

ถ้าฉันมีไฟล์ product.txt ที่จะแยกวิเคราะห์ในอนาคตฉันสามารถกำหนด POJO ของตัวเองชื่อ ProductData ที่จะเก็บเนื้อหาที่ต้องการของไฟล์ จากนั้นฉันสามารถสร้างคลาสคอนกรีตที่ชื่อว่า ProductDataFlatFileParser ซึ่งใช้อินเตอร์เฟส Parser และมีวิธีการแยกวิเคราะห์ซึ่งจะเติม ProductData POJO ให้ฉันหลังจากการแยกไฟล์

การออกแบบนี้สมเหตุสมผลหรือไม่ มีข้อบกพร่องที่ชัดเจนในการออกแบบนี้หรือไม่? ขณะที่การออกแบบย่อมาจากนี้ฉันอนุญาตให้คลาสคอนกรีตเพื่อกำหนดอัลกอริทึมในการแยกวิเคราะห์ไฟล์และให้คลาสคอนกรีตตัดสินใจว่าจะเก็บข้อมูลที่ใด การออกแบบดูเหมือนจะขึ้นอยู่กับวัตถุโดเมนมากกว่ารูปแบบไฟล์ นี่เป็นสิ่งที่ไม่ดีหรือไม่? ข้อมูลใด ๆ เกี่ยวกับวิธีที่ฉันสามารถปรับปรุงการออกแบบของฉันจะได้รับการชื่นชมอย่างมาก

ฉันมีข้อกังวลสองสามข้อ:

1. ฉันจะทำให้แน่ใจว่าคุณต้องการการออกแบบทั่วไปก่อนที่จะนำไปใช้ คุณแน่ใจหรือว่าต้องการไฟล์ประเภทอื่นที่ไม่ใช่ XML ถ้าไม่ทำไมรหัสสำหรับพวกเขา หากคุณต้องการใช้ในที่สุดคุณสามารถติดตั้งรหัสของคุณใหม่ได้ ณ จุดนั้น ใช้เวลาไม่นานนักคุณอาจมีข้อกำหนดอื่น ๆ ที่จะทำให้โค้ดดูแตกต่างจากที่คุณเสนอในปัจจุบันและคุณอาจไม่จำเป็นต้องเขียนมันเลย ตามที่พวกเขาพูด YAGNI (คุณไม่ต้องการมัน)
2. หากคุณต้องการการออกแบบทั่วไปและคุณค่อนข้างแน่ใจในเรื่องนี้ฉันจะบอกว่าParser<T>มันฟังดูดี ฉันเห็นปัญหาที่อาจเกิดขึ้นสองประการ: (1) สมมติว่าอินพุตไฟล์ - ถ้าคุณพยายามแยกสตรีม JSON ที่คุณดึงจากการตอบกลับ HTTP มาเป็นตัวอย่าง และ (2) ไม่จำเป็นต้องให้คุณค่ามากนักยกเว้นเป็นส่วนหนึ่งของกรอบทั่วไปที่มีขนาดใหญ่กว่าซึ่งคุณมีตัวแยกวิเคราะห์หลายประเภทสำหรับข้อมูลประเภทต่าง ๆ มากมาย แต่ฉันไม่มั่นใจว่าคุณต้องการกรอบทั่วไปขนาดใหญ่เช่นนี้ คุณเพียงแค่มีความง่ายมากกรณีการใช้งานที่เป็นรูปธรรมในขณะนี้เท่าที่ผมสามารถบอกได้: แยกไฟล์ XML ลงในรายการของProductDatas
3. ProductDataXmlParserมันเกือบจะไม่เคยมีความคิดที่ดีที่จะกลืนข้อยกเว้นในขณะที่คุณกำลังทำอยู่ใน ฉันจะแปลงเป็นบางประเภทRuntimeExceptionแทน

การออกแบบของคุณไม่ใช่ตัวเลือกที่ดีที่สุด จากการออกแบบของคุณวิธีเดียวที่จะใช้:

ProductDataXMLTYPE parser = new ProductDataXmlParser<ProductDataXMLTYPE>().parse(input); 
ProductDataTextTYPE parser = new ProductDataTextParser<ProductDataTextTYPE >().parse(input);

เราไม่เห็นประโยชน์มากเกินไปจากตัวอย่างด้านบน เราทำสิ่งนี้ไม่ได้:

Parser parser = getParser(string parserName);
parser.parse();

คุณสามารถพิจารณาสองตัวเลือกต่อไปนี้ก่อนที่จะค้นหาทั่วไป:

• 1, เอาต์พุตเดียวกันหลังจากวิเคราะห์คำ

ไม่ว่าแหล่งข้อมูลจะมาจากที่ไหนข้อมูลของผลิตภัณฑ์จะเป็นรูปแบบเดียวกันก่อนที่คุณจะบันทึกลงในฐานข้อมูล เป็นสัญญาระหว่างลูกค้ากับบริการถ่ายโอนข้อมูลของคุณ ดังนั้นฉันสมมติว่าคุณมี ProductData เหมือนกับเอาต์พุต คุณสามารถกำหนดอินเตอร์เฟส:

public interface Parser {
    public ProductData parse(String inputFile);
}

ยิ่งกว่านั้นคุณยังกำหนด ProductData เป็นอินเทอร์เฟซถ้าคุณต้องการความยืดหยุ่น

หากคุณไม่ต้องการให้ Parser ผสมกับข้อมูล คุณสามารถแยกมันเป็นสองอินเตอร์เฟส:

public interface Parser {
     public void parse(String inputFile);
}
public interface Data {
    public ProductData getData();
}

และโปรแกรมแยกวิเคราะห์ของคุณจะมีลักษณะดังนี้:

public class XMLParser implements Parser, Data {} 
public class TextParser implements Parser, Data {}

• 2, การส่งออกที่แตกต่างกันหลังจากแยกวิเคราะห์

หาก ProductData ไม่เหมือนกันและคุณต้องการนำอินเตอร์เฟส Parser กลับมาใช้ใหม่ คุณสามารถทำได้ด้วยวิธีนี้:

public interface Parser {
   public void parse(String inputFile);
}

class XMLParse implements {
      @Override
      public void parse(String inputFile);

      ProductDataXML getProductData();        
}

class TextParse implements {
      @Override
      public void parse(String inputFile);

      ProductDataText getProductData();        
}

ในกรณีที่คุณต้องการใช้สิ่งที่มีอยู่แล้วฉันได้สร้างไลบรารี java ขึ้นมาแล้ว JRecordBindซึ่งใช้ XMLSchema (สำรองโดย JAXB)

มันเกิดมาเพื่อใช้ / สร้างไฟล์ความยาวคงที่และเนื่องจาก XMLSchema กำหนดโครงสร้างของไฟล์คุณสามารถใช้กับ JAXB ธรรมดาเพื่อ marshall / unmarshall XML ไฟล์