corner imagecorner image
FeaturesPluginsDocs & SupportCommunityPartners

Обзор ClearCase для среды IDE NetBeans 6.1

В среде IDE NetBeans 6.1 задачи управления версиями теперь можно выполнять с помощью Rational ClearCase. Поддержка ClearCase в среде IDE предназначена для упрощения выполнения задач управления версиями непосредственно в проекте при работе в среде IDE.

В этом документе описаны базовые действия, выполняемые при работе с ClearCase в среде IDE NetBeans. Здесь также рассматриваются некоторые новые функции управления версиями, включенные в среду IDE, начиная с версии 6.0.

Rational ClearCase представляет собой программное средство для управления версиями, разработанное IBM. ClearCase формирует основу управления версиями проектов для многих крупных компаний, а также предприятий среднего и малого бизнеса.

Содержание

Содержимое на этой странице относится к среде IDE NetBeans 6.1

Для работы с этим руководством требуется программное обеспечение и ресурсы, перечисленные ниже.

Программное обеспечение или ресурс Требуемая версия
Среда IDE NetBeans версия 6.1
Комплект для разработчика на языке Java (JDK) версия 6 или
версия 5
Клиентское программное обеспечение ClearCase  
Подключаемый модуль ClearCase в среде NetBeans версия 0.9.x

Примечание: Для получения подключаемого модуля ClearCase для NetBeans перейдите к диспетчеру подключаемых модулей в среде IDE ("Tools > Plugins" в главном меню) и установите подключаемый модуль, как показано ниже:

Настройка ClearCase

Для получения преимуществ поддержки ClearCase в среде IDE необходимо установить клиентское программное обеспечение ClearCase и запустить его на компьютере.

ClearCase в среде NetBeans поддерживает работу с представлением снимка и динамическим представлением. Представления настраиваются вне среды IDE. Кроме того, необходимо правильно настроить подключение к серверу ClearCase. Для доступа к файлам в представлениях снимков выполнять дополнительные действия не требуется. Однако если требуется получить доступ к файлам из динамического представления, необходимо сначала инициировать его с помощью собственных средств ClearCase, установленных на компьютере.

Примечания:

  • В настоящее время подключение к веб-интерфейсу ClearCase (CCWeb) невозможно.
  • Ограничение для систем *nix: для получения возможности обращения к файлам запуск среды IDE необходимо выполнять из контекста динамических представлений.

Поддержка ClearCase в среде IDE работает при взаимодействии с клиентом cleartool для выполнения команд управления версиями. В зависимости от системы и в случае установки клиента cleartool в каталоге, отличном от каталога по умолчанию, также может потребоваться зарегистрировать путь к исполняемой программе cleartool в среде IDE.

Определение пути к исполняемой программе cleartool

Среда IDE NetBeans предпринимает попытку определить расположение исполняемого файла cleartool с помощью системной переменной $PATH. Однако в зависимости от платформы или в случае установки клиента ClearCase в другом каталоге может потребоваться явно указать путь к исполняемому файлу. Для настройки пути к исполняемому файлу ClearCase в среде IDE выполните следующие действия:

  1. В главном меню выберите "Tools > Options". Откроется диалоговое окно "Options".
  2. Выберите значок "Miscellaneous" в верхней части диалогового окна, а затем откройте вкладку "Versioning". На левой панели в "Versioning Systems" выберите "ClearCase". В главном окне диалога появятся определяемые пользователем параметры для ClearCase:

    Диалоговое окно "ClearCase Options" с определяемыми пользователем параметрами
  3. В текстовом поле "Specify the cleartool Executable Path" введите путь к исполняемому файлу или нажмите кнопку "Browse" для перехода к этому файлу в системе.
  4. Нажмите кнопку "OK", а затем перезапустите среду IDE для вступления изменений в силу.

Примечание: Для получения дополнительных сведений см. Настройка интеграции ClearCase в среде NetBeans и заметки о выпуске.

Начало работы с файлами версий

Начинать работу с ClearCase в среде IDE необходимо с открытия существующего проекта с несколькими версиями или создания нового проекта в представлении ClearCase.

Открытие существующего проекта в среде IDE

Если в системе уже имеется проект ClearCase с несколькими версиями, с которым выполнялись определенные действия, то при открытии этого проекта в среде IDE функции управления версиями становятся доступны автоматически. В среде IDE выполняется сканирование открытых проектов, и если они расположены в каталоге представления ClearCase, автоматически активируется информация о статусе файла и контекстно-зависимая поддержка.

Открытие проекта ClearCase с версиями:

  1. В главном меню выберите "File > Open Project" и выполните требуемые действия с мастером открытия проекта. При определении адреса проекта перейдите к расположению в каталоге представления ClearCase. После завершения работы мастера проект отображается в окне "Projects" (Ctrl-1), и активируется поддержка управления версиями.

Примечание: Открыть проект или каталог можно также в окне "Favorites". Это необходимо в том случае, если каталог ClearCase не является проектом NetBeans. Для этого щелкните правой кнопкой мыши в окне "Favorites" (Ctrl-3) и выберите "Add to Favorites". В появившемся диалоговом окне "Add to Favorites" перейдите к каталогу представления ClearCase верхнего уровня и нажмите кнопку "Add". В окне "Favorites" добавляется представление дерева для этого каталога.

Создание нового проекта и его размещение в "Source Control"

Также можно создать новый проект и разместить его в элементе управления ClearCase, а затем продолжить работу с этим проектом в среде IDE. При создании нового проекта необходимо указать его расположение в представлении ClearCase. Это позволит сообщить среде IDE о необходимости поддержки управления версиями. При создании проекта все файлы первоначально имеют закрытое представление. Далее проект можно добавить на сервер ClearCase с помощью команды "Add to Source Control" среды IDE.

Создание нового проекта:

  1. В главном меню выберите "File > New Project" и выполните требуемые действия с помощью мастера создания проекта. В действии 2 ("Name and Location") выберите каталог в представлении ClearCase. При нажатии "Finish" создается проект, и представление дерева соответствующего каталога добавляется в окне "Projects" (Ctrl-1). После создания проекта среда IDE автоматически распознает, что проект находится в представлении. При этом становятся доступными все соответствующие действия ClearCase и информация о статусе файла.

При открытии проекта с версиями в среде IDE имена всех файлов и папок выделяются зеленым цветом. Это указывает на то, что они имеют статус "new". (Все файлы, выделенные серым цветом, имеют статус "ignored". Для получения дополнительных сведений см. Расшифровка значков и цветов ниже.) В среде IDE для каждого файла проекта с версиями автоматически определяется, требуется ли управление версиями или нет (исходные файлы в пакетах обычно подлежат управлению версиями, а закрытые файла проекта, как правило, игнорируются).

Способ обработки представлений закрытых файлов в среде IDE можно изменить с помощью следующих параметров:

  • Параметр "Schedule View Private Files For checkin" в диалоговом окне ClearCase Options
  • Для указания игнорируемых файлов выберите "Tools > Options > Advanced Options > IDE Configuration > System > System Settings > Ignored Files".

После создания проекта его можно синхронизировать с сервером ClearCase с помощью команды "Add to Source Control" в среде IDE:

  1. Щелкните правой кнопкой мыши узел проекта в окне "Projects" и выберите "Add to source control". Появится диалоговое окно "Add" со списком всех новых закрытых файлов, которые не игнорируются в среде IDE автоматически:
    Диалоговое окно ClearCase "Add"
  2. Введите сообщение в текстовой области "Describing Message". Либо щелкните значок "Recent Messages" (recent messages icon), расположенный в верхнем правом углу, для просмотра и выбора из списка ранее использованных сообщений.
  3. После определения действий для отдельных файлов нажмите кнопку "Add". При выполнении действия "Add" отображается строка состояния среды IDE в правой нижней части интерфейса. После успешного выполнения действия "Add" значки управления версиями исчезают из окон "Projects", "Files" и "Favorites", а зарегистрированные файлы выделяются черным цветом.

Примечание: В диалоговом окне "Add" можно исключить отдельные файлы из действия "Add". Для этого щелкните столбец "Action" выбранного файла и выберите "Do not Add" из раскрывающегося списка.

"Выписка" исходных файлов

После открытия проекта ClearCase с версиями в среде IDE можно внести изменения в исходные файлы. Для изменения файлов ClearCase с версиями требуется сначала "выписать" или захватить их. Поддержка ClearCase в среде NetBeans предоставляет для этого два способа:

  • Вручную: Просто щелкните правой кнопкой мыши узел файла и выберите "ClearCase > Checkout" (или "ClearCase > Hijack").
  • С помощью функции выписки по запросу: Каждый раз при выполнении действия, для которого файл должен быть доступным для записи, в среде IDE автоматически запускается соответствующая команда ClearCase (например, первое изменение содержимого файла в редакторе или выполнение действия реорганизации).

Функция выписки по запросу предоставляет возможности точной настройки с помощью параметра "On Demand checkout" в диалоговом окне ClearCase Options.

Изменение исходного кода

Как и при работе с любым проектом, открытым в среде IDE NetBeans, можно открывать файлы в редакторе исходного кода. Для этого дважды щелкните их узлы в окнах IDE (например, "Projects" (Ctrl-1), "Files" (Ctrl-2) и "Favorites" (Ctrl-3)).

При работе с исходными файлами в среде IDE доступны различные элементы пользовательского интерфейса, которые упрощают просмотр и выполнение команд управления версиями:

Просмотр изменений в редакторе исходного кода

При открытии файла с версиями в редакторе исходного кода в среде IDE можно просмотреть изменения файла в режиме реального времени относительно ранее выписанной версии из хранилища. При выполнении операций в среде IDE в полях редактора исходного кода используются цветовые обозначения:

Синий (       ) Указывает строки, которые были изменены по сравнению с более ранней версией.
Зеленый (       ) Указывает строки, которые были добавлены к более ранней версии.
Красный (       ) Указывает строки, которые были удалены из более ранней версии.

Левое поле в редакторе исходного кода содержит построчные изменения. При изменении данной строки результаты незамедлительно отображаются в левом поле.

Для отмены новых изменений щелкните набор цветов в поле. Например, на левом нижнем снимке экрана показаны элементы оформления окон, для доступа к которым необходимо щелкнуть красный значок, который указывает, что строки из выписанного файла были удалены.

В правом поле редактора исходного кода предоставляется обзор изменений, внесенных во весь файл сверху вниз. Цветовые обозначения появляются сразу же после внесения изменений в файл.

Обратите внимание на то, что при щелчке определенной точки в поле встроенный курсор немедленно перемещается в соответствующее место в файле. Для просмотра количества затронутых строк наведите курсор мыши на цветные значки в правом поле:

Цветовые обозначения управления версиями в левом поле редактора исходного кода
Левое поле
Цветовые обозначения в правом поле редактора исходного кода
Правое поле

Просмотр информации о статусе файла

Для работы в окнах "Projects" (Ctrl-1), "Files" (Ctrl-2), "Favorites" (Ctrl-3) или "Versioning" в среде IDE предусмотрены визуальные средства, которые упрощают просмотр информации о статусе файлов. В приведенном ниже примере обратите внимание на то, как значок (например, синий значок), цвет имени файла и смежная метка статуса соотносятся друг с другом и обеспечивают простой, но эффективный способ отслеживания информации управления версиями:
Синий значок при управлении версиями в окне "Favorites"

Значки, цветовые обозначения, метки статуса файлов и (что, возможно, наиболее важно) окно "Versioning" обеспечивают возможность эффективного просмотра и управления информацией управления версиями в среде IDE.

Расшифровка значков и цветов

Значки применяются на уровне проекта, папки и узла пакета. Они несут информацию о статусе файлов, содержащихся в данном узле:

В следующей таблице представлена система цветов, используемая для значков:

Элемент пользовательского интерфейса Описание
Синий значок (Синий значок) Указывает на наличие файлов или папок, которые были выписаны, захвачены или добавлены. Для пакетов этот значок применим только к самому пакету непосредственно, но не к его подпакетам. Для проектов или папок этот значок указывает на наличие изменений в данном элементе или в любой из содержащихся в нем подпапок.

Для указания текущего состояния файлов в их именах применяются следующие цветовые обозначения:

Цвет Пример Описание
Синий Синий текст Указывает, что файл был выписан.
Зеленый Зеленый текст Указывает, что файл является новым и не был добавлен к элементу управления исходного файла.
Серый Серый текст Указывает, что файл игнорируется ClearCase и не будет включен в команды управления версиями (например, "Add to Source Control" или "Checkin"). Файлы могут игнорироваться только в том случае, если к ним еще не было применено управление версиями.
Зачеркивание Зачеркнутый текст Указывает, что файл исключен из процесса регистрации или операций добавления к управлению исходными файлами. Зачеркнутый текст отображается только в определенных местах, например, в окне "Versioning", диалоговом окне "Checkin" или "Add to Source Control" при исключении отдельных файлов из действия. К таким файлам по-прежнему могут применяться другие команды ClearCase, например, "Update".

Метки статуса файла

Метки статуса файла обеспечивают текстовую индикацию статуса файлов с версиями в окнах среды IDE. По умолчанию в среде IDE информация о статусе ("new", "reserved", "unreserved", "ignored" и т.д.) отображается в виде серого текста справа от файлов при выводе их списка в окнах. Однако этот формат можно изменить в соответствии с собственными требованиями. Например, если к меткам статуса требуется добавить выбор версии, выполните следующие действия:

  1. В главном меню выберите "Tools > Options". Откроется окно "Options".
  2. Нажмите кнопку "Miscellaneous" в верхней части окна, а затем выберите вкладку "Versioning", расположенную ниже. Проверьте, что на левой панели под "Versioning Systems" выбран вариант ClearCase. (Для получения информации см. пример экрана выше.)
  3. Нажмите кнопку "Add Variable" справа от текстового поля "Status Label Format". В появившемся диалоговом окне "Add Variable" выберите переменную {version}, а затем нажмите кнопку "OK". Переменная версии добавляется к текстовому полю "Status Label Format".
  4. Для переформатирования меток статуса для отображения справа от файлов только выбора версии и статуса измените значение в текстовом поле "Status Label Format" следующим образом:
    [{status}; {version}]
    Нажмите кнопку "OK". Метки статуса теперь содержат статус файлов и выбор версии (если применимо):
    Метки файлов, отображаемые напротив имен файлов

Метки статуса файла можно включать или отключать путем выбора "View > Show Versioning Labels" в главном меню.

Окно "Versioning"

В окне "ClearCase Versioning" содержится список всех изменений файлов в выбранной папке локальной рабочей копии в режиме реального времени. Это окно открывается по умолчанию на нижней панели в среде IDE и содержит новые, выписанные или захваченные файлы.

Для открытия окна "Versioning" выберите файл или папку с версиями (например, из окна "Projects", "Files" или "Favorites"), щелкните правой кнопкой мыши и из появившегося меню выберите "ClearCase > Show Changes", либо выберите "Versioning > Show Changes" в главном меню. В нижней части интерфейса среды IDE появится следующее окно:

Окно "Versioning"  с локально измененными файлами

По умолчанию в окне "Versioning" отображается список всех файлов с определенным статусом в рамках выбранного пакета или папки (т. е. "new", "reserved", "unreserved" и т.д.). Для упорядочивания файлов по имени, статусу, расположению или правилу щелкните заголовки столбцов над отображаемыми файлами.

Панель инструментов окна "Versioning" также включает кнопки, которые позволяют вызывать наиболее распространенные задачи ClearCase для всех файлов в списке. В следующей таблице представлен список команд ClearCase, доступных на панели инструментов окна "Versioning":

Значок Имя Функция
Значок "Refresh Status" Refresh Status Обновляет статус выбранных файлов и папок. Файлы, отображаемые в окне "Versioning", можно обновить для отражения всех внешних изменений.
Значок "Diff All" Diff All Открывает Diff Viewer для сравнения локальных изменений с версиями из хранилища.
Значок "Update All" Update All Обновляет все выбранные файлы. (Применимо только к представлениям снимка.)
Значок "Commit All" checkin All Позволяет зарегистрировать локальные изменения.

Доступ к другим командам ClearCase можно получить в окне "Versioning" путем выбора строки таблицы, соответствующей файлу, и команды в меню (для его появления щелкните правой кнопкой мыши):

Меню для выбранного файла в окне "Versioning" (для его вывода щелкните правой кнопкой мыши)


Например, с файлом можно выполнить следующие действия:

  • Show Annotations:

    Отображает информацию об авторе и номере версии в левом поле файлов, открытых в редакторе исходного кода.
Аннотации в левом поле редактора исходного кода – щелкните для УВЕЛИЧЕНИЯ
  • Exclude from Checkin:

    Позволяет отметить файл, который будет исключен из процесса регистрации.
Файлы, исключенные в диалоговом окне "Checkin"

Сравнение версий файлов

При работе с проектами, имеющими несколько версией, одной из распространенных задач является сравнение версий файла. В среде IDE версии можно сравнивать с помощью команды diff, доступной из меню по щелчку правой кнопкой мыши выбранного элемента ("ClearCase > Diff"), а также в окне "Versioning". В окне "Versioning" для выполнения команды diff дважды щелкните файл в списке или щелкните значок Diff All (значок "Diff All") на панели инструментов в верхней части экрана.

При выполнении сравнения для выбранного файла(ов) в главном окне среды IDE открывается графическая программа Diff Viewer. В Diff Viewer две копии отображаются на параллельно расположенных панелях:
Diff Viewer ClearCase

В Diff Viewer для указания на изменения в версиях используются те же цветовые обозначения , что и в других окнах. На примере экрана выше зеленый блок указывает, что к более актуальной версии было добавлено содержимое. Красный блок указывает, что содержимое из более ранней версии в более поздней версии было удалено. Синий блок указывает, что выделенная строка(и) была изменена.

Кроме того, при выполнении команды diff для группы файлов, например, для проекта, пакета или папки, либо при выборе "Diff All" (значок "Diff All") можно перемещаться между результатами путем выбора файлов в верхней области Diff Viewer.

Diff Viewer также предоставляет следующие функциональные возможности:

Изменение выписанного файла

При выполнении команды diff для выписанных файлов можно вносить в них изменения непосредственно в Diff Viewer. Для этого поместите курсор внутри правой панели Diff Viewer и измените файл соответственно, либо используйте встроенные значки, отображаемые рядом с каждым выделенным изменением:

Replace (значок "Replace"): Вставляет выделенный текст из предыдущих версий в выписанную версию.
Move All (значок "Move All"): Возвращает выписанную версию файла в состояние выбранной предыдущей версии.
Remove (значок "Remove"): Удаляет выделенный текст из выписанной версия для обеспечения зеркального соответствия предыдущей версии.

Переход для просмотра отличий между сравниваемыми файлами

Если при выполнении команды diff отображается несколько отличий, между ними можно переходить с помощью значков в виде стрелки на панели инструментов. Эти значки в виде стрелки позволяют просматривать отличия файлов, отображаемые сверху вниз:

Previous (кнопка "Previous Difference"): Используется для перехода к предыдущему отличию, отображаемому в команде diff
Next (кнопка "Next Difference"): Используется для перехода к следующему отличию, отображаемому в команде diff

Регистрация исходных файлов

После внесения изменений в исходные файлы они регистрируются в хранилище. В среде IDE команду checkin можно вызвать следующими способами:

  • В окне "Projects", "Files" или "Favorites" щелкните правой кнопкой мыши новые или выписанные элементы и выберите "ClearCase > Checkin".
  • В окне "Versioning" или в Diff Viewer нажмите кнопку Checkin All (значок "Checkin All") на панели инструментов.

Откроется диалоговое окно "Checkin", отображающее следующее:

  • все полученные файлы;
  • все новые файлы, которые будут сначала автоматически добавлены к элементу управления исходного файла (т.е. файлы с закрытым представлением, для которых еще не выполнялось управление версиями и которые не игнорируются в среде IDE).
Диалоговое окно "Checkin" с файлами, которые будут зарегистрированы

В диалоговом окне "Checkin" можно исключить отдельные файлы из процесса регистрации. Для этого щелкните столбец "Checkin Action" для выбранного файла и выберите из раскрывающегося списка "Exclude from Checkin".

Для выполнения регистрации:

  1. Введите сообщение регистрации в текстовой области "Checkin Message". Либо щелкните значок "Recent Messages" (recent messages icon), расположенный в верхнем правом углу, для просмотра и выбора из списка ранее использованных сообщений.
  2. После определения действий для отдельных файлов нажмите кнопку "Checkin". В среде IDE выполняется регистрация. Ход выполнения регистрации отображается в строке состояния в среде IDE в правой нижней части интерфейса. После успешного выполнения регистрации значки управления версиями исчезают из окон "Projects", "Files" и "Favorites", а полученные файлы выделяются черным цветом.

Дополнительная информация

Это заключительная часть обзора ClearCase для среды IDE NetBeans 6.1. В этом документе описано выполнение базовых задач по управлению версиями в среде IDE в рамках стандартной последовательности выполняемых действий с использованием поддержки ClearCase в IDE.

Для ознакомления с другими связанными документами см. следующие материалы:

Companion
Projects:
MySQL Database Server   GlassFish Community: an Open Source Application Server   Open Solaris  Open JDK: an Open SourceJDK   Mobile & Embedded Community     Sponsored by 
Sponsored by Sun Microsystems