CN103473105A - Realizing method of online code completion function - Google Patents

Abstract

The invention discloses a method for realizing the online code completion function. The method includes steps: 1. Encapsulating the code auxiliary function of the local integrated development environment into a local interface that can be called; 2. Implementing the web service of the code auxiliary function, the web service accepts data related to code operation from the online integrated development environment , call the interface obtained in the first step, obtain the result generated by the local integrated development environment code auxiliary function, and use the result as the result of web service call; 3. Realize the interaction between the online integrated development environment client and server. The online integrated development environment client editing area records the data of the user in the process of editing the code, sends the data to the server, and the server calls the code auxiliary function web service, and returns the obtained results to the client for display. By adopting the method of the invention, codes can be written in the online integrated development environment for users, and the code auxiliary function similar to that of the local integrated development environment is provided.

Description

A Realization Method of Online Code Completion Function

Technical field:

The invention relates to a method for realizing an online code completion function, which is suitable for providing a code completion function for an online integrated development environment, so that when users use the online integrated development environment, they have the same code completion function as the local integrated development environment , belonging to the field of software technology.

Background technique:

With the introduction of cloud computing, various desktop programs are gradually migrated to the cloud. The desktop integrated development environment, as a program closely related to developers, has also begun to be migrated to the cloud, which we call an online integrated development environment. The online integrated development environment has many unique advantages, such as development anytime and anywhere, no need to build a development environment, etc. However, after decades of development, the local integrated development environment already has a complete functional system. Among them, the code completion function of the local integrated development environment has become an indispensable function for developers in the development process. This function can greatly improve the efficiency of developers in the development process. Compared with the local integrated development environment, the functions provided by the existing online integrated development environment are relatively simple, especially the code completion function in the development process cannot be provided, which seriously affects the development of the online integrated development environment.

Invention content:

In view of the above problems, the purpose of the present invention is to provide a method for realizing the online code completion function. The method can add a code completion function to the online integrated development environment, thereby bringing convenience to developers in the development process.

In order to solve the problems of the technologies described above, the technical solution of the present invention is as follows:

A method for implementing an online code completion function, which provides a code completion function similar to a local integrated development environment for users in the process of programming using an online integrated development environment, and is characterized in that it includes the following steps:

(1) Encapsulate the code completion function of the local integrated development environment into a local interface that can be called;

(2) A web service that implements the code completion function. The web service accepts data related to code operations from the online integrated development environment, calls the interface obtained in the first step, and obtains the result generated by the code completion function of the local integrated development environment. The result is the result of the web service call;

(3) Realize the interaction between the online integrated development environment client and server. The online integrated development environment client editing area records the data of the user in the process of editing the code, sends the data to the server, and the server calls the code completion function web service, and returns the obtained results to the client for display.

2. the realization method of online integrated development environment code completion function as claimed in claim 1, is characterized in that, in described step (1), for the code completion function that can call by command line mode, the realization of interface Directly through the command line call statement to achieve.

3. The method for realizing the code completion function of the online integrated development environment as claimed in claim 1, wherein in the step (1), for the code completion function that cannot be invoked through the command line, it is necessary to first extract Output the code corresponding to the function, and then encapsulate the code into an interface.

4. The method for realizing the code completion function of an online integrated development environment as claimed in claim 1, wherein the web service in the step (2) can be a web service conforming to a standard specification, or a generalized web service. Any web service accessed via http on the web.

The technical effect of the present invention is that: the code completion function of the existing local integrated development environment is fully utilized, avoiding the redevelopment of the code completion function, and at the same time, it can ensure that a stable code completion function is provided for the online integrated development environment, because the local integration The code completion function of the development environment has been developed for more than ten years, and the function has become stable. Finally, users can enjoy the convenience of online development while enjoying the high efficiency of the local development process.

Description of drawings

Fig. 1 shows the effect diagram after the code completion function of the online integrated development environment is realized in the present invention

Fig. 2 represents the work flow chart of online integrated development environment code completion function in the present invention

Detailed ways:

Accompanying drawing 1 shows the effect diagram after the code completion function of the online integrated development environment is realized.

Accompanying drawing 2 illustrates the work interaction diagram of the code completion function of the online integrated development environment.

The implementation of the code completion function of the entire online integrated development environment is as follows:

First, we need to design an interface for the local code completion function to interact with the web service. The input of this interface is the code fragment that needs to be completed, and the output is a list of recommended methods and attributes. After designing the interface, we started to implement the interface of local code completion function and web service interaction. When the local code completion function provides the sub-interfaces we need, we can directly call a series of sub-interfaces of the local code completion function to realize the interface for interacting with the web service. When the sub-interface of the local code completion function cannot be called directly, we need to extract the implementation code of the sub-function related to the local code completion function, and integrate these codes into the implementation of the web service interaction interface. In this way, we can fully reuse the existing sub-functions of the local code completion function, and obtain a complete functional realization of the interaction with the web service we need.

Then, we need to design the web service part of the code completion function. The input of this part is the code snippet that needs to be completed, and the output is a list of recommended methods and properties. This section is an intermediary between server-side and native code completion. The implementation of this part is to accept the request sent by the server for code fragments that need to be completed, and then call the interface that has been implemented for the local code completion function to interact with the web service, calculate the recommended method and attribute list, and put the The list is returned to the server as the result of web service processing. The interaction between the Web service and the server can be through the Soap protocol, or through the Http protocol.

Next, we need to design the server side of the code completion function. The server is responsible for receiving the client's request, and then calls the corresponding business logic function according to the different types of the request, obtains the result, and returns the result to the client for display. When we use the server side of the code completion function in advance, we add the request judgment of the code completion function. If the requirements of the request are met, we send the code fragments that need to be completed to the web service, and return the result processed by the web service to the client. show.

Finally, we need to design a client for code completion. The role of the client is to collect user operations on the client. When encountering a user operation that requires a response code completion list, the client collects information on code fragments written by various users, and then sends a code completion request to the server, and the server processes After completion, the result is returned to the client. The client needs to be displayed to the user in the form of a list box, and the user can make a selection in the list box, and then complete the code completion function.

The key technologies are as follows:

(1) Interactive data format

The most common format for data interaction is the string format, but due to the interaction between the client and the server in the online integrated development environment, the interaction between the server and the web service, and the interaction between the web service and the local code completion function, various data such as codes need to be transmitted, not only the amount of data Large, and the type is complex, so you need to use xm1 or JSON format as the format for data interaction. The following list illustrates the data interaction format.

Taking code completion as an example, we want to obtain a list of all methods in object a. The format of the JSON message sent from the main program service to the code completion service is as follows:

The value "cn.edu.pku.TestCode" of mainC1ass is the name of the Java file where object a is located, and the value 300 of 1length is the code length of the entire java file. The value 32 of offset is the offset of a in the entire java file, and the value codeComp1ete of the last command indicates that the code completion service is expected to return all methods and properties of a.

After the code completion service completes the calculation, the result is returned to the main program, and the main program displays all properties and methods of object a in the form of a list. The data returned from the code completion service is also sent back to the main program in JSON format. The contents of the JSON message are as follows:

The value of status ok indicates that the result calculated by the code completion service is normal. The value of the specific returned method and attribute is provided by the value in ret.

Through the JSON format, we can exchange enough information at different levels. (2) Extraction of local code completion function

Since the functions of the local integrated development environment are stable and powerful, if the functions are redeveloped, the cost will be very high. Therefore, we can propose the functions of the local integrated development environment and make them into services, and provide them to the online integrated development environment in the form of services. In order to make the local code completion function into a service, the two most important issues are: (1) How to separate the local code completion function from other functions. (2) How to organize these functions together to form an interface that can interact with web services.

For these two problems, there are two situations: If each sub-function of the local code completion function is provided in the form of an interface, we can call these sub-functions directly without separating them, and organize these sub-functions in a certain logic. Together, as the implementation of the interface called by the web service in the future. If the sub-functions of the local code completion function are mixed with other irrelevant codes, we need to extract the sub-functions in the following three steps and combine them into the implementation of the interface for web service calls.

1) Find the entry point of the function. The so-called entry point of a function refers to the first piece of code implemented by the function.

2) According to code dependencies, gradually expand the code. Starting from the entry point, according to the data dependencies between the codes, all the codes belonging to the sub-function are included in the implementation of the sub-function.

3) Combine all extracted sub-functions. That is, according to certain business logic, each sub-function is combined to realize a complete code completion function.

The following shows the implementation of a sub-interface that provides the native code completion function directly called by the web service.

The input of this code is the java file name (javafi1e), the content of the java file (fi1eContent), the position offset (offset) that needs to be completed, and the output is a list of methods and attributes related to recommended code completion.

Claims (4)

1. an online code is mended Full Featured implementation method, for the user uses in Online integration development environment programming process, provides the code completion that is similar to local Integrated Development Environment function, it is characterized in that, comprises the steps:

(1), by the code completion function of local Integrated Development Environment, being packaged into can invoked local interface;

(2) code is mended Full Featured web service, this web service accepts to operate relevant data from Online integration development environment code, call the interface that the first step obtains, obtain the result that local Integrated Development Environment code completion function generates, the result that this result is called as web service;

(3) realize the mutual of Online integration development environment client and server.Online integration development environment client-side editing district, the data of recording user in the edit code process, send to server end by these data, server end invoke code completion function web service, and the result obtained is returned to the client demonstration.

2. Online integration development environment code as claimed in claim 1 is mended Full Featured implementation method, it is characterized in that, in described step (1), for the code completion function that can be called by command line mode, the realization of interface directly realizes by the order line call statement.

3. Online integration development environment code as claimed in claim 1 is mended Full Featured implementation method, it is characterized in that, in described step (1), for the code completion function that can't be called by command line mode, need at first extract the corresponding code of function, then this code is packaged into to interface.

4. Online integration development environment code as claimed in claim 1 is mended Full Featured implementation method, it is characterized in that, web service in described step (2), can be both the web service that meets standard criterion, can be also sensu lato any web services of accessing by the http mode.

Images