From 682266b591a7d08b0ea823a1fefe40892c973598 Mon Sep 17 00:00:00 2001 From: SerLiunx-ctrl <17689543@qq.com> Date: Sat, 28 Dec 2024 21:57:03 +0800 Subject: [PATCH] =?UTF-8?q?init:=20=E4=BB=93=E5=BA=93=E5=88=9D=E5=A7=8B?= =?UTF-8?q?=E5=8C=96.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 32 + LICENSE.txt | 674 ++++++++++++++++++ README.md | 1 + pom.xml | 39 + .../exception/StateException.java | 28 + .../machine/StandardStateMachine.java | 228 ++++++ .../statemanagement/machine/StateMachine.java | 26 + .../machine/StateMachineBuilder.java | 227 ++++++ .../machine/handler/StateHandler.java | 21 + .../handler/StateHandlerProcessParams.java | 53 ++ .../machine/handler/StateHandlerRegistry.java | 10 + .../machine/handler/StateHandlerWrapper.java | 53 ++ .../manager/AbstractStateManager.java | 184 +++++ .../manager/BidirectionalStateManager.java | 32 + .../DefaultBidirectionalStateManager.java | 66 ++ .../DefaultUnidirectionalStateManager.java | 85 +++ .../manager/StandardStateManager.java | 27 + .../statemanagement/manager/StateManager.java | 35 + .../manager/UnidirectionalStateManager.java | 40 ++ .../support/ExecutorUtils.java | 11 + .../serliunx/statemanagement/MachineTest.java | 41 ++ .../serliunx/statemanagement/ManagerTest.java | 20 + .../statemanagement/support/PrinterState.java | 14 + 23 files changed, 1947 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 pom.xml create mode 100644 src/main/java/com/serliunx/statemanagement/exception/StateException.java create mode 100644 src/main/java/com/serliunx/statemanagement/machine/StandardStateMachine.java create mode 100644 src/main/java/com/serliunx/statemanagement/machine/StateMachine.java create mode 100644 src/main/java/com/serliunx/statemanagement/machine/StateMachineBuilder.java create mode 100644 src/main/java/com/serliunx/statemanagement/machine/handler/StateHandler.java create mode 100644 src/main/java/com/serliunx/statemanagement/machine/handler/StateHandlerProcessParams.java create mode 100644 src/main/java/com/serliunx/statemanagement/machine/handler/StateHandlerRegistry.java create mode 100644 src/main/java/com/serliunx/statemanagement/machine/handler/StateHandlerWrapper.java create mode 100644 src/main/java/com/serliunx/statemanagement/manager/AbstractStateManager.java create mode 100644 src/main/java/com/serliunx/statemanagement/manager/BidirectionalStateManager.java create mode 100644 src/main/java/com/serliunx/statemanagement/manager/DefaultBidirectionalStateManager.java create mode 100644 src/main/java/com/serliunx/statemanagement/manager/DefaultUnidirectionalStateManager.java create mode 100644 src/main/java/com/serliunx/statemanagement/manager/StandardStateManager.java create mode 100644 src/main/java/com/serliunx/statemanagement/manager/StateManager.java create mode 100644 src/main/java/com/serliunx/statemanagement/manager/UnidirectionalStateManager.java create mode 100644 src/main/java/com/serliunx/statemanagement/support/ExecutorUtils.java create mode 100644 src/test/java/com/serliunx/statemanagement/MachineTest.java create mode 100644 src/test/java/com/serliunx/statemanagement/ManagerTest.java create mode 100644 src/test/java/com/serliunx/statemanagement/support/PrinterState.java diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2140a37 --- /dev/null +++ b/.gitignore @@ -0,0 +1,32 @@ +target/ +!.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### IntelliJ IDEA ### +.idea/ + +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ + +### Mac OS ### +.DS_Store \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..dca4edd --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +### StateManagement \ No newline at end of file diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..048123d --- /dev/null +++ b/pom.xml @@ -0,0 +1,39 @@ + + + 4.0.0 + + com.serliunx + state-management + 1.0.0-alpha + + + 8 + 8 + UTF-8 + + + + + junit + junit + 4.13.2 + test + + + + ch.qos.logback + logback-classic + 1.2.13 + test + + + + org.projectlombok + lombok + 1.18.36 + test + + + \ No newline at end of file diff --git a/src/main/java/com/serliunx/statemanagement/exception/StateException.java b/src/main/java/com/serliunx/statemanagement/exception/StateException.java new file mode 100644 index 0000000..f5db758 --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/exception/StateException.java @@ -0,0 +1,28 @@ +package com.serliunx.statemanagement.exception; + +/** + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +public class StateException extends RuntimeException { + + public StateException() { + } + + public StateException(String message) { + super(message); + } + + public StateException(String message, Throwable cause) { + super(message, cause); + } + + public StateException(Throwable cause) { + super(cause); + } + + public StateException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) { + super(message, cause, enableSuppression, writableStackTrace); + } +} diff --git a/src/main/java/com/serliunx/statemanagement/machine/StandardStateMachine.java b/src/main/java/com/serliunx/statemanagement/machine/StandardStateMachine.java new file mode 100644 index 0000000..80e2faf --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/machine/StandardStateMachine.java @@ -0,0 +1,228 @@ +package com.serliunx.statemanagement.machine; + +import com.serliunx.statemanagement.machine.handler.StateHandler; +import com.serliunx.statemanagement.machine.handler.StateHandlerProcessParams; +import com.serliunx.statemanagement.machine.handler.StateHandlerWrapper; +import com.serliunx.statemanagement.manager.AbstractStateManager; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.Executor; + +/** + * 状态机的标准实现 + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +public class StandardStateMachine extends AbstractStateManager implements StateMachine { + + /** + * 进入事件集合 + */ + private final Map>> entryHandlers; + /** + * 离开事件集合 + */ + private final Map>> leaveHandlers; + /** + * 交换事件集合 + */ + private final Map>> exchangeHandlers; + /** + * 异步执行器 + */ + private final Executor executor; + /** + * 是否异步执行 + *

+ * 当具体的执行器没有指定是否异步时, 将根据该值决定是否异步执行. + */ + private final Boolean async; + + /** + * 默认的构造函数 + * + * @param entryHandlers 进入事件处理器集合 + * @param leaveHandlers 离开事件处理器集合 + * @param exchangeHandlers 交换事件处理器集合 + * @param executor 异步执行器 + * @param async 是否异步执行 + */ + StandardStateMachine(List stateList, + Map>> entryHandlers, + Map>> leaveHandlers, + Map>> exchangeHandlers, + Executor executor, + Boolean async + ) { + super(stateList); + this.entryHandlers = entryHandlers; + this.leaveHandlers = leaveHandlers; + this.exchangeHandlers = exchangeHandlers; + this.executor = executor; + this.async = async; + } + + @Override + public S switchPrevAndGet() { + try { + writeLock.lock(); + S oldState = get(); + prev(); + S newState = get(); + invokeHandlers(oldState, newState); + return newState; + } finally { + writeLock.unlock(); + } + } + + @Override + public S getAndSwitchPrev() { + try { + writeLock.lock(); + S oldState = get(); + prev(); + S newState = get(); + invokeHandlers(oldState, newState); + return oldState; + } finally { + writeLock.unlock(); + } + } + + @Override + public void switchPrev() { + try { + writeLock.lock(); + S oldState = get(); + prev(); + S newState = get(); + invokeHandlers(oldState, newState); + } finally { + writeLock.unlock(); + } + } + + @Override + public S switchNextAndGet() { + try { + writeLock.lock(); + S oldState = get(); + next(); + S newState = get(); + invokeHandlers(oldState, newState); + return newState; + } finally { + writeLock.unlock(); + } + } + + @Override + public S getAndSwitchNext() { + try { + writeLock.lock(); + S oldState = get(); + next(); + S newState = get(); + invokeHandlers(oldState, newState); + return oldState; + } finally { + writeLock.unlock(); + } + } + + @Override + public void switchNext() { + try { + writeLock.lock(); + S oldState = get(); + next(); + S newState = get(); + invokeHandlers(oldState, newState); + } finally { + writeLock.unlock(); + } + } + + @Override + public boolean switchTo(S state) { + try { + writeLock.lock(); + S oldState = get(); + boolean result = super.switchTo(state); + if (result) { + S newState = get(); + invokeHandlers(oldState, newState); + } + return result; + } finally { + writeLock.unlock(); + } + } + + @Override + public void reset() { + try { + writeLock.lock(); + S oldState = get(); + super.reset(); + S newState = get(); + invokeHandlers(oldState, newState); + } finally { + writeLock.unlock(); + } + } + + /** + * 触发处理器 + * + * @param from 源状态 + * @param to 目的状态 + */ + private void invokeHandlers(S from, S to) { + // 触发离开处理器 + doInvokeHandlers(leaveHandlers.get(from), from, to); + + // 触发进入处理器 + doInvokeHandlers(entryHandlers.get(to), from, to); + + // 触发交换处理器 + final String key = from.toString() + "-" + to.toString(); + doInvokeHandlers(exchangeHandlers.get(key), from, to); + } + + /** + * 触发 + */ + private void doInvokeHandlers(List> handlerWrappers, S from, S to) { + if (handlerWrappers == null) { + return; + } + // 全局的异步状态 + final boolean isGlobalAsync = async != null && async; + + handlerWrappers.forEach(hw -> { + final StateHandler stateHandler; + if (hw == null || + (stateHandler = hw.getStateHandler()) == null) { + return; + } + + final Executor executorToRun = hw.getExecutor() == null ? executor : hw.getExecutor(); + final boolean runInAsync = hw.getAsync() == null ? isGlobalAsync : hw.getAsync(); + final StateHandlerProcessParams params = new StateHandlerProcessParams<>(from, to, null); + + if (runInAsync) { + if (executorToRun == null) { + throw new NullPointerException(); + } + executorToRun.execute(() -> stateHandler.handle(params)); + } else { + stateHandler.handle(params); + } + }); + } +} diff --git a/src/main/java/com/serliunx/statemanagement/machine/StateMachine.java b/src/main/java/com/serliunx/statemanagement/machine/StateMachine.java new file mode 100644 index 0000000..471ba41 --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/machine/StateMachine.java @@ -0,0 +1,26 @@ +package com.serliunx.statemanagement.machine; + +import com.serliunx.statemanagement.manager.BidirectionalStateManager; + +/** + * 状态机定义 + *

+ * 基于双向的状态管理器扩展 {@link BidirectionalStateManager}, 切换逻辑依赖于内置的状态管理器; + * 同时可以多种监听事件, 包括: + *

  • 切换至指定状态时触发 (进入事件) + *
  • 切出指定状态时触发 (离开事件) + *
  • 从A切换到B状态时触发 (交换事件) + *

    + * 推荐使用{@link StateMachineBuilder} 来构建状态机. + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + * @see StateMachineBuilder + * @see BidirectionalStateManager + * @see com.serliunx.statemanagement.manager.StateManager + */ +public interface StateMachine extends BidirectionalStateManager { + + +} diff --git a/src/main/java/com/serliunx/statemanagement/machine/StateMachineBuilder.java b/src/main/java/com/serliunx/statemanagement/machine/StateMachineBuilder.java new file mode 100644 index 0000000..9328444 --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/machine/StateMachineBuilder.java @@ -0,0 +1,227 @@ +package com.serliunx.statemanagement.machine; + +import com.serliunx.statemanagement.machine.handler.StateHandler; +import com.serliunx.statemanagement.machine.handler.StateHandlerWrapper; +import com.serliunx.statemanagement.manager.BidirectionalStateManager; + +import java.util.*; +import java.util.concurrent.Executor; + +/** + * 状态机构建 + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +public final class StateMachineBuilder { + + /** + * 状态管理器 + */ + private List stateList; + /** + * 执行器 + */ + private Executor executor; + /** + * 是否异步执行 + */ + private Boolean async; + + /** + * 各种事件 + */ + private final Map>> entryHandlers = new HashMap<>(64); + private final Map>> leaveHandlers = new HashMap<>(64); + private final Map>> exchangeHandlers = new HashMap<>(64); + + // private-ctor + private StateMachineBuilder() {} + + /** + * 添加交换事件 + *

  • 从A状态切换至B状态时触发 + * + * @param from 源状态 + * @param to 目的状态 + * @param handler 处理器 + * @param async 是否异步执行 + * @param executor 异步执行器, 异步执行时将使用, 不指定时将使用状态机内置的执行器 + */ + public StateMachineBuilder exchange(S from, S to, StateHandler handler, Boolean async, Executor executor) { + final String key = from.toString() + "-" + to.toString(); + final List> stateHandlerWrappers = exchangeHandlers.computeIfAbsent(key, + k -> new ArrayList<>()); + stateHandlerWrappers.add(new StateHandlerWrapper<>(handler, executor, async)); + return this; + } + + /** + * 添加交换事件 + *
  • 从A状态切换至B状态时触发 + * + * @param from 源状态 + * @param to 目的状态 + * @param handler 处理器 + * @param async 是否异步执行 + */ + public StateMachineBuilder exchange(S from, S to, StateHandler handler, Boolean async) { + return exchange(from, to, handler, async, null); + } + + /** + * 添加交换事件 + *
  • 从A状态切换至B状态时触发 + * + * @param from 源状态 + * @param to 目的状态 + * @param handler 处理器 + */ + public StateMachineBuilder exchange(S from, S to, StateHandler handler) { + return exchange(from, to, handler, null); + } + + /** + * 添加离开事件 + *
  • 从指定状态切换到别的状态时执行的逻辑 + * + * @param state 状态 + * @param handler 处理逻辑 + * @param async 是否异步执行 + * @param executor 异步执行器, 异步执行时将使用, 不指定时将使用状态机内置的执行器 + */ + public StateMachineBuilder whenLeave(S state, StateHandler handler, Boolean async, Executor executor) { + final List> stateHandlerWrappers = leaveHandlers.computeIfAbsent(state, + k -> new ArrayList<>()); + stateHandlerWrappers.add(new StateHandlerWrapper<>(handler, executor, async)); + return this; + } + + /** + * 添加离开事件 + *
  • 从指定状态切换到别的状态时执行的逻辑 + * + * @param state 状态 + * @param handler 处理逻辑 + * @param async 是否异步执行 + */ + public StateMachineBuilder whenLeave(S state, StateHandler handler, Boolean async) { + return whenLeave(state, handler, async, null); + } + + /** + * 添加离开事件 + *
  • 从指定状态切换到别的状态时执行的逻辑 + * + * @param state 状态 + * @param handler 处理逻辑 + */ + public StateMachineBuilder whenLeave(S state, StateHandler handler) { + return whenLeave(state, handler, null); + } + + /** + * 添加进入事件 + *
  • 切换到了指定状态时执行的逻辑 + * + * @param state 状态 + * @param handler 处理逻辑 + * @param async 是否异步执行 + * @param executor 异步执行器, 异步执行时将使用, 不指定时将使用状态机内置的执行器 + */ + public StateMachineBuilder whenEntry(S state, StateHandler handler, Boolean async, Executor executor) { + final List> stateHandlerWrappers = entryHandlers.computeIfAbsent(state, + k -> new ArrayList<>()); + stateHandlerWrappers.add(new StateHandlerWrapper<>(handler, executor, async)); + return this; + } + + /** + * 添加进入事件 + *
  • 切换到了指定状态时执行的逻辑 + * + * @param state 状态 + * @param handler 处理逻辑 + * @param async 是否异步执行 + */ + public StateMachineBuilder whenEntry(S state, StateHandler handler, Boolean async) { + return whenEntry(state, handler, async, null); + } + + /** + * 添加进入事件 + *
  • 切换到了指定状态时执行的逻辑 + * + * @param state 状态 + * @param handler 处理逻辑 + */ + public StateMachineBuilder whenEntry(S state, StateHandler handler) { + return whenEntry(state, handler, null); + } + + /** + * 指定状态机的执行器 + *

    + * 优先级低于添加事件时指定的执行器 + * + * @param executor 执行器 + */ + public StateMachineBuilder executor(Executor executor) { + this.executor = executor; + return this; + } + + /** + * 定义状态机是否异步执行 + * + * @param async 是否异步执行 + */ + public StateMachineBuilder async(Boolean async) { + this.async = async; + return this; + } + + /** + * 定义状态机为异步执行 + */ + public StateMachineBuilder async() { + return async(true); + } + + /** + * 设置状态列表 + */ + public StateMachineBuilder states(S[] states) { + return states(Arrays.asList(states)); + } + + /** + * 设置状态列表 + */ + public StateMachineBuilder states(List states) { + stateList = states; + return this; + } + + /** + * 构建 + */ + @SuppressWarnings("unchecked") + public > M build() { + return (M) new StandardStateMachine<>(stateList, entryHandlers, + leaveHandlers, exchangeHandlers, executor, async); + } + + /** + * 状态机构建器 + * + * @param stateClass 状态类 + * @return 状态机构建器实例 + * @param 状态类参数 + */ + @SuppressWarnings("all") + public static StateMachineBuilder from(Class stateClass) { + return new StateMachineBuilder<>(); + } +} diff --git a/src/main/java/com/serliunx/statemanagement/machine/handler/StateHandler.java b/src/main/java/com/serliunx/statemanagement/machine/handler/StateHandler.java new file mode 100644 index 0000000..b5a3278 --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/machine/handler/StateHandler.java @@ -0,0 +1,21 @@ +package com.serliunx.statemanagement.machine.handler; + +/** + * 状态处理器 + *

    + * 定义状态进入、离开及切换时执行的逻辑 + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +@FunctionalInterface +public interface StateHandler { + + /** + * 处理 + * + * @param params 参数 + */ + void handle(StateHandlerProcessParams params); +} \ No newline at end of file diff --git a/src/main/java/com/serliunx/statemanagement/machine/handler/StateHandlerProcessParams.java b/src/main/java/com/serliunx/statemanagement/machine/handler/StateHandlerProcessParams.java new file mode 100644 index 0000000..f3e8677 --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/machine/handler/StateHandlerProcessParams.java @@ -0,0 +1,53 @@ +package com.serliunx.statemanagement.machine.handler; + +import com.serliunx.statemanagement.manager.BidirectionalStateManager; + +/** + * 状态处理器入参 + *

    + * 用于状态机处理事件 + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +@SuppressWarnings("all") +public final class StateHandlerProcessParams { + + /** + * 源状态 + */ + private final S from; + /** + * 目标状态 + */ + private final S to; + /** + * 附加参数 + */ + private final Object attach; + + /** + * @param from 原状态 + * @param to 目标状态 + * @param attach 附加参数 + * @param bidirectionalStateManager 状态机内置的状态管理器 + */ + public StateHandlerProcessParams(S from, S to, Object attach) { + this.from = from; + this.to = to; + this.attach = attach; + } + + public S getFrom() { + return from; + } + + public S getTo() { + return to; + } + + public Object getAttach() { + return attach; + } +} diff --git a/src/main/java/com/serliunx/statemanagement/machine/handler/StateHandlerRegistry.java b/src/main/java/com/serliunx/statemanagement/machine/handler/StateHandlerRegistry.java new file mode 100644 index 0000000..6485f07 --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/machine/handler/StateHandlerRegistry.java @@ -0,0 +1,10 @@ +package com.serliunx.statemanagement.machine.handler; + +/** + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +public class StateHandlerRegistry { + +} diff --git a/src/main/java/com/serliunx/statemanagement/machine/handler/StateHandlerWrapper.java b/src/main/java/com/serliunx/statemanagement/machine/handler/StateHandlerWrapper.java new file mode 100644 index 0000000..58c26f1 --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/machine/handler/StateHandlerWrapper.java @@ -0,0 +1,53 @@ +package com.serliunx.statemanagement.machine.handler; + +import java.util.concurrent.Executor; + +/** + * 处理器封装 + *

    + * 用于添加处理器时设置处理器的行为 + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +@SuppressWarnings("all") +public final class StateHandlerWrapper { + + /** + * 状态处理器 + */ + private final StateHandler stateHandler; + /** + * 执行器 + *

  • 用于异步执行处理逻辑 + */ + private final Executor executor; + /** + * 是否异步执行 + */ + private final Boolean async; + + /** + * @param stateHandler 状态处理器 + * @param executor 执行器 + * @param async 是否异步执行 + */ + public StateHandlerWrapper(StateHandler stateHandler, Executor executor, Boolean async) { + this.stateHandler = stateHandler; + this.executor = executor; + this.async = async; + } + + public StateHandler getStateHandler() { + return stateHandler; + } + + public Executor getExecutor() { + return executor; + } + + public Boolean getAsync() { + return async; + } +} diff --git a/src/main/java/com/serliunx/statemanagement/manager/AbstractStateManager.java b/src/main/java/com/serliunx/statemanagement/manager/AbstractStateManager.java new file mode 100644 index 0000000..c398981 --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/manager/AbstractStateManager.java @@ -0,0 +1,184 @@ +package com.serliunx.statemanagement.manager; + +import java.util.Arrays; +import java.util.List; +import java.util.concurrent.locks.ReentrantReadWriteLock; + +/** + * 状态管理器的抽象实现 + *

    + * 提供了最基本功能的实现以及部分供子类使用的参数,如:锁、当前状态的序号等. + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +public abstract class AbstractStateManager implements StateManager { + + /** + * 状态列表 + */ + private final List stateList; + + /** + * 当前状态的序号 + *

    请保证仅在有写锁的情况下去修改 + */ + private volatile int index; + + /** + * 锁 + */ + private final ReentrantReadWriteLock lock = new ReentrantReadWriteLock(); + /** + * 读锁 + */ + protected final ReentrantReadWriteLock.ReadLock readLock = lock.readLock(); + /** + * 写锁 + */ + protected final ReentrantReadWriteLock.WriteLock writeLock = lock.writeLock(); + + /** + * @param stateList 状态列表 + */ + public AbstractStateManager(List stateList) { + this.stateList = stateList; + index = 0; + } + + /** + * @param states 状态数组 + */ + public AbstractStateManager(S[] states) { + this(Arrays.asList(states)); + } + + /** + * 保留空构造器 + */ + public AbstractStateManager() { + this((List) null); + } + + @Override + public S current() { + try { + readLock.lock(); + return get(); + } finally { + readLock.unlock(); + } + } + + @Override + public boolean switchTo(S state) { + int i = indexOf(state); + if (i == -1) { + return false; + } + try { + writeLock.lock(); + index = i; + } finally { + writeLock.unlock(); + } + return true; + } + + @Override + public void reset() { + try { + writeLock.lock(); + index = getDefault(); + } finally { + writeLock.unlock(); + } + } + + /** + * 将序号移动至下一个 + *

  • 自动归零 + *
  • 仅在持有写锁的情况下访问 + */ + @SuppressWarnings("all") + protected void next() { + if (++index >= stateList.size()) + index = 0; + } + + /** + * 将序号移动至上一个 + *
  • 自动归零 + *
  • 仅在持有写锁的情况下访问 + */ + @SuppressWarnings("all") + protected void prev() { + if (--index < 0) + index = 0; + } + + /** + * 获取当前状态 + *

    + * 类及子类访问当前状态时不允许使用{@link #current()},因为会造成死锁 + * + *

  • 仅在持有锁的情况下访问 + * + * @return 当前状态 + */ + protected S get() { + return stateList.get(index); + } + + /** + * 获取指定状态在状态列表中的序号 + * + * @param state 状态 + * @return 序号 {@link List#indexOf(Object)} + */ + protected int indexOf(S state) { + return stateList.indexOf(state); + } + + /** + * 判断当前状态是否为状态列表中的最后一个 + * + * @return 是最后一个时返回真, 否则返回假. + */ + protected boolean isLast() { + return index == stateList.size() - 1; + } + + /** + * 判断当前状态是否为状态列表中的第一个 + * + * @return 是第一个时返回真, 否则返回假. + */ + protected boolean isFirst() { + return index == getDefault(); + } + + /** + * 获取当前状态的序号 + * + * @return 当前状态序号 + */ + protected int currentIndex() { + return index; + } + + /** + * 更新当前状态的序号 + */ + protected void updateCurrentIndex(int newIndex) { + index = newIndex; + } + + /** + * 状态序号默认值(等同于默认状态) + */ + protected int getDefault() { + return 0; + } +} diff --git a/src/main/java/com/serliunx/statemanagement/manager/BidirectionalStateManager.java b/src/main/java/com/serliunx/statemanagement/manager/BidirectionalStateManager.java new file mode 100644 index 0000000..c5e0b67 --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/manager/BidirectionalStateManager.java @@ -0,0 +1,32 @@ +package com.serliunx.statemanagement.manager; + +/** + * 双向流转的状态管理器 + *

    + * 基于单向流转的状态管理器{@link UnidirectionalStateManager} 实现, 在其基础上允许了反方向切换状态 + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +public interface BidirectionalStateManager extends UnidirectionalStateManager { + + /** + * 切换至上一个状态并返回切换后的状态 + * + * @return 切换后的状态 + */ + S switchPrevAndGet(); + + /** + * 获取当前状态并切换至上一个状态 + * + * @return 切换前的状态 + */ + S getAndSwitchPrev(); + + /** + * 切换至上一个状态 + */ + void switchPrev(); +} diff --git a/src/main/java/com/serliunx/statemanagement/manager/DefaultBidirectionalStateManager.java b/src/main/java/com/serliunx/statemanagement/manager/DefaultBidirectionalStateManager.java new file mode 100644 index 0000000..b288725 --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/manager/DefaultBidirectionalStateManager.java @@ -0,0 +1,66 @@ +package com.serliunx.statemanagement.manager; + +import java.util.List; + +/** + * 双向流转的状态管理器的默认实现 + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +public class DefaultBidirectionalStateManager extends DefaultUnidirectionalStateManager + implements BidirectionalStateManager { + + /** + * @param stateList 状态列表 + */ + public DefaultBidirectionalStateManager(List stateList) { + super(stateList); + } + + /** + * @param states 状态数组 + */ + public DefaultBidirectionalStateManager(S[] states) { + super(states); + } + + @Override + public S switchPrevAndGet() { + try { + writeLock.lock(); + prev(); + return get(); + } finally { + writeLock.unlock(); + } + } + + @Override + public S getAndSwitchPrev() { + try { + writeLock.lock(); + S current = get(); + prev(); + return current; + } finally { + writeLock.unlock(); + } + } + + @Override + public void switchPrev() { + try { + writeLock.lock(); + prev(); + } finally { + writeLock.unlock(); + } + } + + @Override + public boolean switchTo(S state) { + return defaultSwitchTo(state); + } +} diff --git a/src/main/java/com/serliunx/statemanagement/manager/DefaultUnidirectionalStateManager.java b/src/main/java/com/serliunx/statemanagement/manager/DefaultUnidirectionalStateManager.java new file mode 100644 index 0000000..c93bf0d --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/manager/DefaultUnidirectionalStateManager.java @@ -0,0 +1,85 @@ +package com.serliunx.statemanagement.manager; + +import java.util.List; + +/** + * 单向流转的状态管理器的默认实现 + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +public class DefaultUnidirectionalStateManager extends AbstractStateManager + implements UnidirectionalStateManager { + + /** + * @param stateList 状态列表 + */ + public DefaultUnidirectionalStateManager(List stateList) { + super(stateList); + } + + /** + * @param states 状态数组 + */ + public DefaultUnidirectionalStateManager(S[] states) { + super(states); + } + + @Override + public S switchNextAndGet() { + try { + writeLock.lock(); + next(); + return get(); + } finally { + writeLock.unlock(); + } + } + + @Override + public S getAndSwitchNext() { + try { + writeLock.lock(); + S current = get(); + next(); + return current; + } finally { + writeLock.unlock(); + } + } + + @Override + public void switchNext() { + try { + writeLock.lock(); + next(); + } finally { + writeLock.unlock(); + } + } + + @Override + public boolean switchTo(S state) { + try { + writeLock.lock(); + final int i; + if ((i = indexOf(state)) == -1 || + (!isLast() && i < currentIndex()) || + (isLast() && i != getDefault())) { + return false; + } + updateCurrentIndex(i); + } finally { + writeLock.unlock(); + } + return true; + } + + /** + * 保留默认的切换方式供子类使用 + */ + protected boolean defaultSwitchTo(S state) { + return super.switchTo(state); + } +} diff --git a/src/main/java/com/serliunx/statemanagement/manager/StandardStateManager.java b/src/main/java/com/serliunx/statemanagement/manager/StandardStateManager.java new file mode 100644 index 0000000..0e1c2b1 --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/manager/StandardStateManager.java @@ -0,0 +1,27 @@ +package com.serliunx.statemanagement.manager; + +import java.util.List; + +/** + * 最简单的状态管理器实现 + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +public final class StandardStateManager extends AbstractStateManager { + + /** + * @param stateList 状态列表 + */ + public StandardStateManager(List stateList) { + super(stateList); + } + + /** + * @param states 状态数组 + */ + public StandardStateManager(S[] states) { + super(states); + } +} diff --git a/src/main/java/com/serliunx/statemanagement/manager/StateManager.java b/src/main/java/com/serliunx/statemanagement/manager/StateManager.java new file mode 100644 index 0000000..a7109ee --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/manager/StateManager.java @@ -0,0 +1,35 @@ +package com.serliunx.statemanagement.manager; + +import java.util.concurrent.locks.ReentrantReadWriteLock; + +/** + * 状态管理器 + *

    + * 将状态集合按照一定的逻辑流转 + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +public interface StateManager { + + /** + * 获取当前状态 + * + * @return 当前最新状态 + */ + S current(); + + /** + * 切换到指定状态 + * + * @param state 新的状态 + * @return 切换成功返回真, 否则返回假 + */ + boolean switchTo(S state); + + /** + * 重置回默认状态, 一般为状态集合中的第一个 + */ + void reset(); +} diff --git a/src/main/java/com/serliunx/statemanagement/manager/UnidirectionalStateManager.java b/src/main/java/com/serliunx/statemanagement/manager/UnidirectionalStateManager.java new file mode 100644 index 0000000..439345e --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/manager/UnidirectionalStateManager.java @@ -0,0 +1,40 @@ +package com.serliunx.statemanagement.manager; + +/** + * 单向流转的状态管理器 + *

    + * 其基本逻辑等同于 {@link StateManager}, 但存在以下不同: + *

  • 状态只能单方向流动(最后一个状态允许切换至第一个状态), 如果有A, B, C, D 四种状态则存在以下几种情况: + *

    + *

    + *

  • A -> B 允许直接切换, A -> C 允许直接切换, C -> D 允许直接切换 等等.. + *
  • B -> A 不允许切换, C -> A 不允许切换, D -> C 不允许切换 等等.. + *
  • 特例: D -> A 是允许的, 因为D是最后一个状态, 故可以切换至第一个状态. + *

    + * 即状态的切换只允许一个方向,不允许向前流动,除非到达最后一个状态! + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +public interface UnidirectionalStateManager extends StateManager { + + /** + * 切换至下一个状态并返回切换后的状态 + * + * @return 切换后的状态 + */ + S switchNextAndGet(); + + /** + * 返回并切换至下一个状态 + * + * @return 切换前的状态 + */ + S getAndSwitchNext(); + + /** + * 切换至下一个状态 + */ + void switchNext(); +} diff --git a/src/main/java/com/serliunx/statemanagement/support/ExecutorUtils.java b/src/main/java/com/serliunx/statemanagement/support/ExecutorUtils.java new file mode 100644 index 0000000..02623aa --- /dev/null +++ b/src/main/java/com/serliunx/statemanagement/support/ExecutorUtils.java @@ -0,0 +1,11 @@ +package com.serliunx.statemanagement.support; + +/** + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +public final class ExecutorUtils { + + private ExecutorUtils() {throw new UnsupportedOperationException();} +} diff --git a/src/test/java/com/serliunx/statemanagement/MachineTest.java b/src/test/java/com/serliunx/statemanagement/MachineTest.java new file mode 100644 index 0000000..2330450 --- /dev/null +++ b/src/test/java/com/serliunx/statemanagement/MachineTest.java @@ -0,0 +1,41 @@ +package com.serliunx.statemanagement; + +import com.serliunx.statemanagement.machine.StateMachine; +import com.serliunx.statemanagement.machine.StateMachineBuilder; +import com.serliunx.statemanagement.support.PrinterState; +import lombok.extern.slf4j.Slf4j; +import org.junit.Test; + +import java.util.concurrent.Executors; + +/** + * 状态机测试 + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +@Slf4j +public class MachineTest { + + @Test + public void testStandardStateMachine() { + StateMachine stateMachine = StateMachineBuilder.from(PrinterState.class) + .async(false) + .whenLeave(PrinterState.PRINTING, h -> { + System.out.println(Thread.currentThread().getName() + ": leave PRINTING"); + }) + .states(PrinterState.values()) + .executor(Executors.newFixedThreadPool(16)) + .whenEntry(PrinterState.SCANNING, h -> { + System.out.println(Thread.currentThread().getName() + ": " + h.getFrom() + " >>> " + h.getTo()); + }, false) + .whenEntry(PrinterState.PRINTING, h -> { + System.out.println(Thread.currentThread().getName() + ": " + h.getFrom() + " >>> " + h.getTo()); + }, false, Executors.newFixedThreadPool(1)) + .exchange(PrinterState.STOPPED, PrinterState.IDLE, h -> { + System.out.println(Thread.currentThread().getName() + ": " + h.getFrom() + " >>> " + h.getTo()); + }) + .build(); + } +} diff --git a/src/test/java/com/serliunx/statemanagement/ManagerTest.java b/src/test/java/com/serliunx/statemanagement/ManagerTest.java new file mode 100644 index 0000000..ee8e885 --- /dev/null +++ b/src/test/java/com/serliunx/statemanagement/ManagerTest.java @@ -0,0 +1,20 @@ +package com.serliunx.statemanagement; + +import lombok.extern.slf4j.Slf4j; +import org.junit.Test; + +/** + * 状态管理器测试 + * + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +@Slf4j +public class ManagerTest { + + @Test + public void testUnidirectionalStateManager() { + + } +} diff --git a/src/test/java/com/serliunx/statemanagement/support/PrinterState.java b/src/test/java/com/serliunx/statemanagement/support/PrinterState.java new file mode 100644 index 0000000..13a8d21 --- /dev/null +++ b/src/test/java/com/serliunx/statemanagement/support/PrinterState.java @@ -0,0 +1,14 @@ +package com.serliunx.statemanagement.support; + +/** + * @author SerLiunx + * @version 1.0.0 + * @since 2024/12/28 + */ +public enum PrinterState { + IDLE, + SCANNING, + PRINTING, + STOPPING, + STOPPED +}