как создать совместный редактор Excel с GridJs

Руководство по совместному редактору Excel

Обзор архитектуры

Следующая диаграмма показывает, как GridJs обеспечивает совместное редактирование несколькими пользователями, на базе Spring Boot, WebSocket-соединения и базы данных MySQL для управления состоянием.

Архитектура совместного редактирования GridJs

Предварительные требования

Перед началом убедитесь, что у вас установлено следующее:

  • Java 8+
  • Maven
  • MySQL (или другая поддерживаемая SQL-база данных)
  • (по желанию) Docker, если предпочитаете запускать в контейнерах
  • Действительная лицензия Aspose.Cells (или временная лицензия)

Step 1: Clone the Demo Project

Clone the official Aspose.Cells GridJs demo repository:

git clone https://github.com/aspose-cells/Aspose.Cells.Grid-for-Java.git
cd Aspose.Cells-for-Java/Examples.GridJs.Collaborative

Step 2: Configure Collaborative Mode

Open the src/main/resources/application.properties file and adjust the settings:

# Directory containing spreadsheet files
testconfig.ListDir=/app/wb

# Directory for storing cache files
testconfig.CachePath=/app/grid_cache

# Aspose.Cells license file
testconfig.AsposeLicensePath=/app/license

# Enable collaborative mode
gridjs.iscollabrative=true

# Database connection (example: MySQL)
spring.datasource.url=jdbc:mysql://localhost:3306/gridjsdemodb?createDatabaseIfNotExist=true&useUnicode=true&serverTimezone=UTC&useSSL=false
spring.datasource.username=root
spring.datasource.password=root
spring.sql.init.platform=mysql

Это позволяет нескольким пользователям одновременно редактировать одну таблицу.
Изменения сохраняются в базе данных и синхронизируются между клиентами в реальном времени.

Step 3: Run the Application

Run with Maven:

mvn spring-boot:run

Или прямо из основного класса:

src/main/java/com/aspose/gridjsdemo/usermanagement/UserManagementApplication.java

Step 4: Test Collaborative Editing

Open your browser and navigate to:
👉 http://localhost:8080/gridjsdemo/list

Steps:

  1. A login page appears. Click Create User to register User1 and log in. You will then see the file list.
  2. Open a file from the list. The spreadsheet editor will load.
  3. Copy the same URL into another browser window. It will redirect to the login page. Create User2 and log in.
  4. Both users now see the same spreadsheet.
  5. If User1 edits the spreadsheet, User2 will see the changes in real time.
  6. If User2 edits, User1 will see the changes as well.
  7. Users can also download and save the file.

Шаг 5: Запуск в Docker (необязательно)

Если вы запускаете в Docker, отредактируйте строку 10 файла docker-compose.yml, чтобы сместить файл лицензии.

Например, если ваш файл лицензии находится по пути C:/license/aspose.lic:

volumes:
  - C:/license/aspose.lic:/app/license  # optional: set Aspose license file

Это отображает локальный файл в контейнере.

Затем выполните сборку и запуск:

docker-compose up --build

Доступ к приложению по адресу:
👉 http://localhost:8080/gridjsdemo/list

Key Configuration Details

1. Enable Collaborative Mode

In /src/main/resources/application.properties:

gridjs.iscollabrative=true

В конфигурации на стороне сервера /src/main/java/com/aspose/gridjsdemo/filemanagement/FileConfig.java:

@Bean
public GridJsOptions gridJsOptions() {
    //..... other options
    //here we shall set true for collaborative mode
    options.setCollaborative(true);
    return options;
}

Или глобально:

Config.setCollaborative(true);

В настройках загрузки на стороне клиента /src/main/resources/templates/file/index.html:

const option = {
    //..... other options
    //here we shall set true for collaborative mode
    isCollaborative: true
    //..... other options
};

2. User System Integration

The demo uses Spring Security for a simple user system.

You must provide a CoWorkUserProvider implementation to connect GridJs with your user system:

In server-side config /src/main/java/com/aspose/gridjsdemo/filemanagement/FileConfig.java:

For example: here we defined MyCustomUser to implement all the interfaces in CoWorkUserProvider.

@Bean
public CoWorkUserProvider currentUserProvider() {
    return new MyCustomUser();
}

В /src/main/java/com/aspose/gridjsdemo/filemanagement/MyCustomUser.java:

public class MyCustomUser implements CoWorkUserProvider {
    //Get the current login user name
    @Override
    public String getCurrentUserName() {
        return getCurrentUser().getUsername();
    }

    //Get the current login user Id
    @Override
    public Long getCurrentUserId() {
        return getCurrentUser().getUserId();
    }

    //Get the current login user permission
    @Override
    public CoWorkUserPermission getPermission() {
        return CoWorkUserPermission.EDITABLE;
    }

    private static CustomUserDetails getCurrentUser() {
        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
        if (authentication != null && authentication.getPrincipal() instanceof CustomUserDetails) {
            return (CustomUserDetails) authentication.getPrincipal();
        }
        throw new IllegalStateException("User not authenticated");
    }
}

3. WebSocket Configuration

The demo uses Spring WebSocket with STOMP.

Example config:

In /src/main/java/com/aspose/gridjsdemo/messages/WebSocketConfig.java:

public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
    @Override
    public void configureMessageBroker(MessageBrokerRegistry config) {
        config.enableSimpleBroker("/topic");
        config.setApplicationDestinationPrefixes("/app");
        config.setUserDestinationPrefix("/user");
    }

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        registry.addEndpoint("/ws")
                .setAllowedOrigins("http://localhost:8080")
                .withSockJS();
    }
}

GridJs ожидает, что messageTopic совпадет с “/topic/opr”, что является значением по умолчанию:

com.aspose.gridjs.Config.setMessageTopic("/topic/opr");

Или:

@Bean
    public GridJsOptions gridJsOptions() {
	//.... other options
    	options.setMessageTopic("/topic/opr");
    	//.... other options
        return options;
    }

На стороне клиента:

xs.setCollaborativeSetting('/GridJs2/msg','/ws','/app/opr','/user/queue','/topic/opr');

Здесь, /GridJs2/msg соответствует маршруту, определенному в
src/main/java/com/aspose/gridjsdemo/filemanagement/controller/GridJsOprController.java:

@RequestMapping("/GridJs2/msg")

Пример с пользовательскими путями WebSocket

Если ваш сервер использует другую конфигурацию:

public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
    @Override
    public void configureMessageBroker(MessageBrokerRegistry config) {
        config.enableSimpleBroker("/topic_gridjs");
        config.setApplicationDestinationPrefixes("/app_gridjs");
        config.setUserDestinationPrefix("/user_gridjs");
    }

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        registry.addEndpoint("/ws_gridjs")
                .setAllowedOrigins("http://localhost:8080")
                .withSockJS();
    }
}

Тогда вам нужно установить:

Сторона сервера:

com.aspose.gridjs.Config.setMessageTopic("/topic_gridjs/opr");

или

    @Bean
    public GridJsOptions gridJsOptions() {
	//.... other option
    	options.setMessageTopic("/topic_gridjs/opr");
    	//.... other option
        return options;
    }

Клиентская сторона:

xs.setCollaborativeSetting('/GridJs2/msg','/ws_gridjs','/app_gridjs/opr','/user_gridjs/queue','/topic_gridjs/opr');

подробная документация по setCollaborativeSetting доступна здесь

⚠️ Примечание: по умолчанию демонстрационная конфигурация работает из коробки.
Дополнительная настройка требуется только если ваше приложение настраивает WebSocket-ендпоинты.

Также помните: режим совместной работы не поддерживает ленивую загрузку.
Не включайте Config.setLazyLoading(true).

Additional Notes

  • We can add file uploads to load and edit spreadsheet file from upload directory.
  • Integrate with cloud storage like AWS S3 or Azure Blob.

Заключение

С помощью Aspose.Cells.GridJs вы можете быстро создать мощный совместный редактор Excel.
Комбинация Java backend, GridJs frontend, SQL хранилища и WebSocket сообщений обеспечивает надежное редактирование таблиц в реальном времени.

Resources

проверка синтаксиса и автозамена ошибок для GridJs