एक GUI को स्टेट मशीन के रूप में लागू करना

एक बड़े प्रोजेक्ट में आने के बाद, जो एक ग्राफिकल इंटरफ़ेस के रूप में स्विंग का उपयोग करता है, मैंने महसूस किया कि JDialog या JFrame घटकों के बीच तर्क और कनेक्शन को समझना अभी भी आसान नहीं है। और हर समय जब मैं इस कोड के साथ काम कर रहा था, तो मैं कुछ ऐसे सार्वभौमिक समाधान खोजने की कोशिश कर रहा था जो इंटरफ़ेस तत्वों के बीच कनेक्शन की जटिलता से बचेंगे।



मुख्य समस्या जो मुझे आई थी: प्रत्येक तत्व में एक या एक से अधिक प्रॉपर्टीचेंजलिस्टर होते हैं, जो स्थिति (अन्य तत्वों की स्थिति से पढ़े) के आधार पर, किसी न किसी तरह से अन्य तत्वों को प्रभावित करते हैं। उन तत्वों, बदले में, उनकी अपनी प्रॉपर्टीचेंजलिस्टर भी होती है, जो संदर्भ के आधार पर भी दूसरों को प्रभावित करती है। कभी-कभी यह समझना बहुत मुश्किल था कि एक बटन दबाने से अन्य सभी तत्वों पर क्या प्रभाव पड़ेगा, और कोड का एक टुकड़ा खोजने के लिए जहां ऐसा होता है, सभी अधिक है। यह निर्भरता के परिवर्तन को भी जटिल करता है (तार्किक नियम को बदलने के लिए, मुझे विभिन्न घटकों पर अलग-अलग स्थानों में सभी कनेक्शनों की तलाश करनी थी, और सबसे अधिक संभावना है कि कुछ छूट गया था) और डीबगिंग।

ऐसी स्थिति में, मध्यस्थ पैटर्न मदद कर सकता है, लेकिन फिर से, सभी कनेक्शनों को ट्रेस करना और बातचीत के तर्क भी मुश्किल होंगे। प्रत्येक JDialog को छोटे JPanels में तोड़ना संभव है जो कुछ तार्किक स्थानों को घेरता है, लेकिन फिर से, हमें इन JPanels की परस्पर क्रिया को बनाए रखने की आवश्यकता है। यदि JDialog पहले से ही सीधी है, तो टूटने के लिए कुछ भी नहीं होगा।

मेरे दिमाग में यह विचार आया कि JDialog हमेशा एक निश्चित समय पर कड़ाई से परिभाषित राज्यों में होता है। उदाहरण के लिए, संवाद बनाया गया था, यह "मैं अभी-अभी बनाई गई" स्थिति में है, फिर उपयोगकर्ता या प्रोग्राम लॉजिक स्वयं "I am प्रसंस्करण" स्थिति में संवाद डालता है, यदि उपयोगकर्ता "I am प्रसंस्करण" स्थिति के दौरान रद्द बटन पर क्लिक करता है, तो संवाद "पर जाता है" मैं बाधित हो गया था। ”

तर्क इतना अच्छा क्यों है? प्रत्येक व्यक्तिगत समय में, हम एक तार्किक स्थिति प्रदान करने पर ध्यान केंद्रित कर सकते हैं। और, इसलिए, तत्वों की स्थिति के लिए जिम्मेदार सभी कोड एक तार्किक और भौतिक स्थान में होंगे। यह समझने के लिए सभी प्रॉपर्टीचेंजलिस्टर्स के माध्यम से खोज करना आवश्यक नहीं है कि जेबटन के "रद्द" को JLabel स्थिति को कैसे प्रभावित किया जा सकता है जब इसे कुछ उपयोगकर्ता इंटरैक्शन के बाद क्लिक किया गया था। वही परिवर्तन के लिए जाता है। उदाहरण के लिए, हमारे पास एक संवाद है जो पृष्ठभूमि थ्रेड में कुछ करता है और इसकी प्रगति को प्रकाशित करता है। संवाद वर्तमान प्रगति के साथ प्रगति बार प्रदर्शित करता है। यदि उपयोगकर्ता रद्द बटन पर क्लिक करता है, तो हम JProgressBar रीसेट करते हैं। अब हमने पृष्ठभूमि प्रक्रिया के प्रारंभ बटन को अक्षम करने का भी फैसला किया, अगर इसे रद्द कर दिया गया था। जब हमारा इंटरफ़ेस राज्यों का उपयोग करते हुए लिखा जाता है, तो हम बस यह पता लगाते हैं कि राज्य "मैं बाधित था" और startButton.setEnabled (झूठा) वहाँ जोड़ें, और हम अपने परिवर्तन में आश्वस्त हैं, यह जानते हुए कि यह केवल तार्किक स्थिति को प्रभावित करता है "मुझे रद्द कर दिया गया"।

इसलिए, उपयोगकर्ता इंटरफ़ेस को राज्यों के एक सेट के रूप में प्रोग्राम करना आवश्यक है जिसमें संवाद प्रवेश करता है और बाहर निकलता है। कम शब्द अधिक कोड!

एक उदाहरण के रूप में, हम एक संवाद पर विचार करते हैं जो आपको मुख्य प्रश्न का उत्तर खोजने की अनुमति देता है।

यह वर्ग उस व्यक्ति का प्रतिनिधित्व करता है जो उत्तर जानता है:

/** * class that can answer to the maing question * @author __nocach */ public class MeaningOfLifeAnswerer { public int answer(){ return 42; } } 

चूंकि उत्तर इतना सरल नहीं है, हमें एक वर्ग तैयार करने की भी आवश्यकता है जो मुख्य प्रश्न का उत्तर दे सके। तैयारी में लंबा समय लगता है, और इसे SwingWorker के माध्यम से करने की आवश्यकता होती है।

 /** * worker that prepares MeaningOfLifeAnswerer * @author __nocach */ public class PrepareToAnswerMeaningOfLife extends SwingWorker<MeaningOfLifeAnswerer, Void>{ @Override protected MeaningOfLifeAnswerer doInBackground() throws Exception { Thread.sleep(1500); return new MeaningOfLifeAnswerer(); } } 

इसका उत्तर ढूंढना भी एक लंबा ऑपरेशन है, और इसे स्विंगवॉकर के माध्यम से किया जाना चाहिए:

 /** * worker that will retrieve answer to the main question using passed Answerer * @author __nocach */ public class RetrieveMeaningOfLife extends SwingWorker<Integer, Integer>{ private final MeaningOfLifeAnswerer answerer; public RetrieveMeaningOfLife(MeaningOfLifeAnswerer answerer){ if (answerer == null){ throw new NullPointerException("prepareProvider can't be null"); } this.answerer = answerer; } @Override protected Integer doInBackground() throws Exception { for(int i = 0; i < 100; i++){ Thread.sleep(10); setProgress(i); } return answerer.answer(); } } 

इंटरफ़ेस से आवश्यकताएँ: संवाद बनाने और प्रदर्शित करने के बाद, हम अर्थऑफलाइफऑनस्वर को इनिशियलाइज़ करने के लिए वर्कर को शुरू करते हैं, सर्च के लिए बटन को डिसेबल करते हैं, और स्टेटस में लिखते हैं कि हम अर्थऑफलाइफएन्स्वायर तैयार कर रहे हैं। जैसे ही MeaningOfLifeAnswerer को इनिशियलाइज़ किया जाता है, सर्च के लिए बटन को ऑन करें। खोज बटन दबाकर, हम RetrieveMeaningOfLife कार्यकर्ता शुरू करते हैं, खोज बटन बंद करें और लिखें कि हम खोज में हैं। उत्तर मिलने के बाद, खोज बटन को फिर से चालू करें और उस बटन पर लिखें जिसे हम फिर से खोज करने के लिए तैयार हैं।

एक विशिष्ट दृष्टिकोण कुछ इस तरह दिखाई देगा:

 public class StandardWay extends javax.swing.JFrame { private Logger logger = Logger.getLogger(StandardWay.class.getName()); private class FindAnswerAction extends AbstractAction{ private final MeaningOfLifeAnswerer answerer; public FindAnswerAction(MeaningOfLifeAnswerer answerer){ super("Find"); this.answerer = answerer; } @Override public void actionPerformed(ActionEvent e) { RetrieveMeaningOfLife retrieveWorker = new RetrieveMeaningOfLife(answerer); retrieveWorker.addPropertyChangeListener(new PropertyChangeListener() { @Override public void propertyChange(PropertyChangeEvent evt) { if ("progress".equals(evt.getPropertyName())){ progressBar.setValue((Integer)evt.getNewValue()); } if ("state".equals(evt.getPropertyName())){ if (StateValue.STARTED.equals(evt.getNewValue())){ //    doButton.setText("In Search"); doButton.setEnabled(false); labelStatus.setText("searching..."); } if (StateValue.DONE.equals(evt.getNewValue())){ RetrieveMeaningOfLife worker = (RetrieveMeaningOfLife)evt.getSource(); try{ Integer answer = worker.get(); //   logger.info("got the answer"); JOptionPane.showMessageDialog(rootPane, "THE ANSWER IS " + answer); } catch(Exception ex){ //     logger.info("error while retrieving the answer"); JOptionPane.showMessageDialog(rootPane, "Error while searching for meaning of life"); } labelStatus.setText("answer was found"); doButton.setText("Find again"); doButton.setEnabled(true); } } } }); retrieveWorker.execute(); } } /** * listener that updates gui state by progress of PrepareToAnswerMeaningOfLife worker * @author __nocach * */ private class PrepareToAnswerMeaningOfLifeListener implements PropertyChangeListener{ @Override public void propertyChange(PropertyChangeEvent evt) { if ("state".equals(evt.getPropertyName())){ if (StateValue.STARTED.equals(evt.getNewValue())){ //      MeaningOfLifeAnswerer labelStatus.setText("Prepearing... "); doButton.setEnabled(false); logger.info("preparing..."); } if (StateValue.DONE.equals(evt.getNewValue())){ //           labelStatus.setText("I am prepared to answer the meaning of life"); doButton.setEnabled(true); PrepareToAnswerMeaningOfLife worker = (PrepareToAnswerMeaningOfLife)evt.getSource(); try{ doButton.setAction(new FindAnswerAction(worker.get())); logger.info("prepared"); } catch(Exception ex){ //    MeaningOfLifeAnswerer JOptionPane.showMessageDialog(rootPane, "failed to find answerer to the question"); dispose(); logger.severe("failed to prepare"); } } } } } /** Creates new form StandardWay */ public StandardWay() { initComponents(); PrepareToAnswerMeaningOfLife prepareWorker = new PrepareToAnswerMeaningOfLife(); prepareWorker.addPropertyChangeListener(new PrepareToAnswerMeaningOfLifeListener()); prepareWorker.execute(); } //... //     JFrame  //... private javax.swing.JButton doButton; private javax.swing.JLabel labelStatus; private javax.swing.JProgressBar progressBar; } 

इसलिए, राज्य को बदलने के लिए सभी कोड दो प्रॉपर्टीचेंजिस्टनर में तैयार किए गए हैं (ReadyToAnswerMeaningOfLife कार्यकर्ता और RetrieveMeaningOfLife कार्यकर्ता)। ReadyToAnswerMeaningOfLifeListener के साथ संवाद का तर्क शुरू होता है, जो लॉन्च किए गए की तैयारी की प्रगति पर नजर रखता है। मुख्य प्रश्न के उत्तर की खोज करते समय हम अपने इंटरफ़ेस की स्थिति को सिंक्रनाइज़ करने के लिए एक अनाम प्रॉपर्टीचेंजलिस्टर जोड़ते हैं। वास्तव में, उपरोक्त सूची को एक स्वीकार्य रूप में लाया जा सकता है यदि प्रत्येक, तार्किक रूप से राज्य के पूरे परिवर्तन को अलग सेट विधि के रूप में रखा गया है ViewToPreparing (), जहां कोड

 private void setViewToPreparing(){ labelStatus.setText("Prepearing... "); doButton.setEnabled(false); logger.info("preparing..."); } 

लेकिन अगर आपके संवाद में प्रत्येक ऐसा तार्किक टुकड़ा 20 से अधिक लाइनों का होगा, तो रेंडर किए गए तरीकों को और भी छोटे तरीकों में विभाजित करने की आवश्यकता होगी, इसलिए JFrame वर्ग को बहुत अधिक संबंधित निजी विधियों की एक बड़ी संख्या के साथ पैक किया जाएगा।

परिमित ऑटोमेटा का उपयोग करने के लिए दृष्टिकोण क्या होगा:

 public class StateMachineWay extends javax.swing.JFrame { private Logger logger = Logger.getLogger(StandardWay.class.getName()); /** * controlls switching between gui states */ private GuiStateManager stateManager = new GuiStateManager(); private class PreparingAnswererState extends BaseGuiState{ @Override public void enterState() { labelStatus.setText("Prepearing... "); doButton.setEnabled(false); } } private class ReadyToFindTheAnswer extends BaseGuiState{ private final MeaningOfLifeAnswerer answerer; public ReadyToFindTheAnswer(MeaningOfLifeAnswerer answerer){ this.answerer = answerer; } @Override public void enterState() { labelStatus.setText("I am prepared to answer the meaning of life"); doButton.setEnabled(true); doButton.setAction(new FindAnswerAction(answerer)); } } private class FoundAnswerState extends BaseGuiState{ private final Integer answer; public FoundAnswerState(Integer answer){ this.answer = answer; } @Override public void enterState() { labelStatus.setText("answer was found"); doButton.setText("Find again"); doButton.setEnabled(true); JOptionPane.showMessageDialog(rootPane, "THE ANSWER IS " + answer); } } private class FailedToPrepareAnswerer extends BaseGuiState{ @Override public void enterState() { JOptionPane.showMessageDialog(rootPane, "failed to find answerer to the question"); dispose(); } } private class FailedToFoundAnswer extends BaseGuiState{ @Override public void enterState() { labelStatus.setText("failed to find answer"); doButton.setText("Try again"); doButton.setEnabled(true); JOptionPane.showMessageDialog(rootPane, "Error while searching for meaning of life"); } } private class SearchingForAnswer extends BaseGuiState{ @Override public void enterState() { labelStatus.setText("searching..."); doButton.setText("In Search"); doButton.setEnabled(false); } } /** * actions that starts worker that will find the answer to the main question * @author __nocach * */ private class FindAnswerAction extends AbstractAction{ private final MeaningOfLifeAnswerer answerer; public FindAnswerAction(MeaningOfLifeAnswerer answerer){ super("Find"); this.answerer = answerer; } @Override public void actionPerformed(ActionEvent e) { RetrieveMeaningOfLife retrieveWorker = new RetrieveMeaningOfLife(answerer); retrieveWorker.addPropertyChangeListener(new PropertyChangeListener() { @Override public void propertyChange(PropertyChangeEvent evt) { if ("progress".equals(evt.getPropertyName())){ progressBar.setValue((Integer)evt.getNewValue()); } if ("state".equals(evt.getPropertyName())){ if (StateValue.DONE.equals(evt.getNewValue())){ RetrieveMeaningOfLife worker = (RetrieveMeaningOfLife)evt.getSource(); try{ Integer answer = worker.get(); stateManager.switchTo(new FoundAnswerState(answer)); logger.info("got the answer"); } catch(Exception ex){ logger.info("error while retrieving the answer"); stateManager.switchTo(new FailedToFoundAnswer()); } } if (StateValue.STARTED.equals(evt.getNewValue())){ stateManager.switchTo(new SearchingForAnswer()); } } } }); retrieveWorker.execute(); } } /** * listener that updates gui state by progress of PrepareToAnswerMeaningOfLife worker * @author __nocach * */ private class PrepareToAnswerMeaningOfLifeListener implements PropertyChangeListener{ @Override public void propertyChange(PropertyChangeEvent evt) { if ("state".equals(evt.getPropertyName())){ if (StateValue.STARTED.equals(evt.getNewValue())){ logger.info("preparing..."); stateManager.switchTo(new PreparingAnswererState()); } if (StateValue.DONE.equals(evt.getNewValue())){ PrepareToAnswerMeaningOfLife worker = (PrepareToAnswerMeaningOfLife)evt.getSource(); try{ MeaningOfLifeAnswerer meaningOfLifeAnswerer = worker.get(); stateManager.switchTo(new ReadyToFindTheAnswer(meaningOfLifeAnswerer)); logger.info("prepared"); } catch(Exception ex){ logger.severe("failed to prepare"); stateManager.switchTo(new FailedToPrepareAnswerer()); } } } } } /** Creates new form StandardWay */ public StateMachineWay() { initComponents(); PrepareToAnswerMeaningOfLife prepareWorker = new PrepareToAnswerMeaningOfLife(); prepareWorker.addPropertyChangeListener(new PrepareToAnswerMeaningOfLifeListener()); prepareWorker.execute(); } //... //     JFrame  //... private javax.swing.JButton doButton; private javax.swing.JLabel labelStatus; private javax.swing.JProgressBar progressBar; } 

मुख्य वर्ग GuiStateManager हैं।

 /** * State machine of swing gui * @author __nocach */ public class GuiStateManager { private GuiState currentState = new EmptyState(); /** * makes passed state current * @param newState not null new state */ public synchronized void switchTo(GuiState newState){ if (newState == null){ throw new NullPointerException(); } currentState.leaveState(); currentState = newState; currentState.enterState(); } public GuiState current(){ return currentState; } } 

एक राज्य मशीन वर्ग जो राज्यों को बदलने और राज्यों में प्रवेश करने और बाहर निकलने के लिए उपयुक्त तरीकों को कॉल करने के लिए जिम्मेदार है।

और वर्ग राज्य GuiState

 public interface GuiState { /** * called when entering to this state */ public void enterState(); /** * called when leaving this state */ public void leaveState(); } 

राज्य मशीन के माध्यम से संपर्क करते समय, हम अंततः निम्नलिखित आंतरिक वर्गों के साथ आए:
PreparingAnswererState,
ReadyToFindTheAnswer,
FoundAnswerState,
FailedToPrepareAnswerer,
FailedToFoundAnswer

उपरोक्त उदाहरण में, हार्ड-कोडित तर्क के बजाय, अब एक राज्य के लिए एक संक्रमण है और उदाहरण के लिए और कुछ नहीं:

 stateManager.switchTo(new ReadyToFindTheAnswer(meaningOfLifeAnswerer)); 

तत्वों को बदलने के सभी तर्क उस स्थिति में केंद्रित होते हैं जिसमें हमने स्विच किया था (इस मामले में, ReadyToFindTheAnswer, जो खोज बटन को सक्रिय बनाता है और JLabel के लेबल और बटन बदल देता है)। यह ध्यान देने योग्य है कि अब हम आसानी से राज्य स्विचिंग के स्थान को स्थानांतरित कर सकते हैं, या विभिन्न स्थानों में एक ही स्विचिंग का उपयोग कर सकते हैं।

कोई कह सकता है कि हमने सिर्फ कक्षाओं का एक समूह बनाया है, लेकिन इस मामले में हम कोड की पठनीयता बढ़ाने के लिए 5 वर्गों का उपयोग करते हैं, क्योंकि प्रत्येक वर्ग का नाम एक राज्य का नाम है।

अब, जब हम अर्थ का व्यवहार बदलना चाहते हैं, जिस समय हमने अर्थऑफलाइफएन्स्विएर तैयार किया (अर्थात, हमने उत्तर खोज प्रारंभ बटन को सक्रिय कर दिया है) हमें बस रेडीफाइंडइंडएन्स्विएर स्टेट को खोजने और जोड़ने की जरूरत है, उदाहरण के लिए, एक संदेश के साथ एक पॉप-अप संवाद जिसे हम जवाब देने के लिए तैयार हैं। एक सवाल।

प्रत्येक राज्य वर्ग को स्वतंत्र रूप से reflored किया जा सकता है _locally_ बाहरी JFrame को अनावश्यक चर या विधियों के साथ बंद किए बिना। राज्य की कक्षाओं को बाद में परीक्षण के लिए अलग-अलग फाइलों में ले जाया जा सकता है।

इसके अलावा, यह दृष्टिकोण _forces_ संवाद कोड को और अधिक स्पष्ट रूप से लिखने के लिए, प्रत्येक राज्य के लिए एक तार्किक नाम के साथ एक अलग छोटा वर्ग बनाता है। हालांकि, ज़ाहिर है, यहां आप बड़ी संख्या में अनाम कक्षाओं के साथ सब कुछ बर्बाद कर सकते हैं।

उपरोक्त राज्य मशीन कोड केवल एक विचार का एक उदाहरण है। मैं पहला व्यक्ति नहीं हूं जिसने उपयोगकर्ता इंटरफ़ेस को एक परिमित राज्य मशीन के रूप में सोचने का फैसला किया है, और इसलिए एक तैयार-निर्मित SwingStates ढांचा है जिसने इस विचार को काफी गहराई से सोचा है।

खैर, जाहिर है, इस दृष्टिकोण का उपयोग किसी भी भाषा में किसी भी डेस्कटॉप एप्लिकेशन में किया जा सकता है।

नमूना कोड यहाँ उपलब्ध है।