Shulou(Shulou.com)06/01 Report--

The content of this article mainly focuses on how the sequence diagram operation of the IDEA one-button generation method is narrated. The content of the article is clear and clear. It is very suitable for beginners to learn and is worth reading. Interested friends can follow the editor to read together. I hope you can get something through this article!

In our daily study / work, we are often faced with the following scenarios:

Read other people's code

Read the frame source code

Read the code you wrote a long time ago.

Never think that work is simply writing code. In practice, you will find that you actually spend most of your time reading and understanding existing code.

In order to understand the invocation relationship between objects more quickly and clearly, I often need to use sequence diagrams. Drawing sequence diagrams manually is troublesome and time-consuming, but IDEA provides a plug-in called SequenceDiagram to help us solve this problem. Through the plug-in SequenceDiagram, we can generate sequence diagrams with one click.

What is a sequence diagram?

There are many definitions of sequence diagrams on the Internet, which I think are not easy to understand and too abstract. The most amazing thing is that the definition of sequence diagram in most articles is exactly the same. It seems that everyone has given full play to the "essence" of writing code.

Let me briefly talk about my understanding. However, to be honest, I am not very clear about Sequence Diagram myself. If there are any problems and areas that need to be improved in the following description, please also point out.

Sequence diagrams (Sequence Diagram), also known as sequence diagrams, are UML behavior diagrams. Represents the sequential invocation relationship between objects when the system performs a method / operation, such as a login operation.

This sequential invocation relationship can be understood as follows: you need to execute the method / operation login provided by object an in the system, but the object relies on the method getUser provided by object b (get user). Therefore, there is the theory of a-> b call relationship.

Give me two more examples!

The following figure is WeChat Pay's business process sequence diagram. This diagram describes the sequential invocation relationship between basic payment and payment in the case of WeChat Pay's related roles (customers, merchants.) in the WeChat Pay scenario.

The following figure is a sequence diagram that I wrote to execute a method in a HTTP framework. This diagram describes the invocation relationship between the classes involved when we call the loadInterceptors () method of the InterceptorFactory class.

In addition, China generally prefers to call sequence diagrams "sequence diagrams".

If you speak from the perspective of pure translation, the word sequence has no meaning of "time", only sequence, sequence and so on, so some people say that the term "sequence diagram" is not accurate.

From a definition point of view, the description of the sequence diagram is fine. Because the trigger timing of each message in Sequence Diagram is indeed executed in chronological order.

I think it's okay to call Sequence Diagram a sequence diagram or a sequence diagram, and you don't have to struggle too much.

In which scenarios do you need to view the sequence diagram of the class?

We need sequence diagrams in many scenarios, such as:

Read the source code: when reading the source code, you may need to look at the calling relationships of the relevant classes involved in calling the target method. Especially when there are many levels of calls to the code, it is very useful for us to understand the source code. (digression: in practical work, we actually spend most of our time reading and understanding existing code. )

Technical documentation: when we write project introduction documents, in order to make your code easier for others to understand, you need to generate sequence diagrams for related classes according to the core methods to show the invocation relationship between them.

Combing business processes: when our system business processes are more complex, we can use sequence diagrams to visualize the relationship between important roles and objects involved in the system.

...

How to use IDEA to generate sequence diagrams based on methods in a class?

Through the plug-in SequenceDiagram, we can generate sequence diagrams with one click.

And you can also:

Click the class / method in the sequence diagram to jump to the corresponding place.

Removes the corresponding class or method from the sequence diagram.

Export the generated timing chart to PNG picture format.

Installation

We can find this plug-in directly in the IDEA plug-in market. I've already installed it here.

If you cannot use the plug-in market that comes with IDEA due to network problems, you can also download and install it manually through the official website of the IDEA plug-in market.

Easy to use

Select the method name (do not select the class name), then right-click and select the Sequence Diagram option!

After configuring some basic parameters of the generated sequence diagram, such as call depth, we can click ok!

You can also locate the relevant code through the generated timing diagram, which is especially helpful for us to read the source code!

After the timing diagram has been generated, you can also choose to export it as a picture.

Thank you for your reading, I believe you have a certain understanding of the "IDEA one-button generation method of sequence diagram operation" this question, quickly practice it, if you want to know more related knowledge points, you can pay attention to the website! The editor will continue to bring you better articles!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.