참고용으로만 봐주시고, 틀린 점이 있으면 언제든 태클 걸어주세요.
* url: https://getcomposer.org/doc/01-basic-usage.md
기본 사용법
소개
기본 사용법을 소개하면서 로깅 라이브러리인monolog/monolog를 설치할 것이다. 아직 컴포저를 설치하지 않았다면 소개 장을 참조하라. 참고: 단순화를 위해 이 소개는 컴포저의 로컬 설치를 가정할 것이다.
composer.json: 프로젝트 세팅
프로젝트에 컴포저를 사용하기 위해서 여러분은 composer.json 파일이 필요하다. 이 파일은 여러분의 프로젝트의 의존성에 대해서 기술할 뿐 아니라 다른 메타데이터도 포함할 수 있다.
require 키
composer.json에서 지정할 첫 번째 (또는 자주 할) 일은 require 키이다. 여러분은 프로젝트에 의존하는 패키지를 컴포저에 간단히 지정할 수 있다.{
"require": {
"monolog/monolog": "1.0.*"
}
}require은 패키지 이름 (예: monolog/monolog) 을 패키지 버전 (예: 1.0.*) 으로 매핑한 객체를 가져온다.패키지 이름
패키지 이름은 벤더 이름과 프로젝트 이름으로 구성된다. 보통 벤더 이름과 프로젝트 이름은 동일하다. 벤더 이름은 그저 이름 충돌을 막기 위해 존재하기 때문이다. 벤더 이름은 서로 다른 두 사람이 각각igorw/json과 seldaek/json으로 json이라는 같은 이름의 라이브러리를 생성할 수 있도록 한다.우리는 여기서
monolog/monolog를 요구하고 있고 벤더 이름은 프로젝트의 이름과 동일하다. 고유한 프로젝트 이름을 사용하는 것이 좋다. 나중에 같은 네임스페이스 아래서 연관된 프로젝트를 많이 추가할 수 있기 때문이다. 여러분이 라이브러리를 유지한다면 더 작은 부분으로 나누기 쉬울 것이다. 패키지 버전
이전 예제에서 우리는 모놀로그 버전1.0.* 을 요청했다. 이는 1.0 개발 브랜치의 버전을 의미한다. 그 버전은 >=1.0<1.1과 일치하는 버전에 해당한다.버전 제약은 몇 가지 방법으로 지정할 수 있고 이 주제에 대한 자세한 정보는 버전 문서를 참조하라.
안정성
기본적으로 안정된 릴리즈만 대상으로 한다. 만약 의존성의 RC, 베타, 알파, 개발 버전을 얻으려면 안정성 플래그를 사용하여 얻을 수 있다. 의존성 하나당 수행하는 것 대신 모든 패키지를 변경하려면 여러분은 최소 안정성 설정을 사용할 수 있다.의존성 설치
프로젝트에서 정의된 의존성을 설치하려면 그저install 명령어를 실행하면 된다.php composer.phar installmonolog/monolog의 최신 버전을 찾고 vendor 디렉토리로 다운로드 한다. 이것은 vendor라는 디렉토리로 외부 코드를 놓는 규약이다. 모놀로그의 경우 vendor/monolog/monolog로 놓는다.팁: 여러분의 프로젝트가 git을 사용한다면 아마
vendor를 .gitignore에 추가해야 한다. 절대 저장소의 모든 코드를 추가하면 안된다.여러분은
install 명령이 composer.lock 파일도 만들었다는 것을 알 수 있다.
composer.lock - 잠금파일
의존성 설치 후 컴포저는 composer.lock 파일에 설치해야 할 정확한 버전 리스트를 작성할 것이다. 이것은 특정 버전으로 프로젝트를 고정한다.버전 컨트롤에 애플리케이션의 (
composer.json과 함께) composer.lock을 커밋한다.이 내용은 중요하다. 왜냐하면 잠금파일이 존재하면
install 명령어는 체크하여 그곳에 (composer.json에 뭐라고 적혀있든지) 지정된 버전을 다운로드 하기 때문이다.잠금 파일을 커밋하는 것은 프로젝트를 설정하는 그 누구도 의존성에서 정확히 같은 버전을 다운로드 하지 않을 것을 의미한다. 여러분의 CI 서버, 생산 기기, 여러분 팀의 다른 개발자, 모든 것과 모두는 구축하는 일부에 영향을 미치는 버그를 완화하는 동일한 의존성에서 실행한다. 심지어 여러분이 프로젝트 재설치로 6달 동안 혼자 개발할 때도 새로운 버전으로 많이 릴리즈 되더라도 설치된 의존성은 여전히 동작한다고 느낄 수 있다.
만약에
composer.lock 파일이 없으면 컴포저는 composer.json에서 의존성과 버전을 읽고 update와 install 명령어를 실행한 후에 잠금 파일을 만들 것이다.잠금 파일을 만든다는 것은 의존성의 새로운 버전이 나오더라도 여러분은 자동으로 업데이트 받지 않는다는 것을 의미한다. 새로운 버전으로 업데이트 하려면
update 명령어를 사용한다. 그러면 매칭되는 (여러분의 composer.json 파일에 따라서) 최근 버전을 받을 것이고 새로운 버전으로 잠금파일을 갱신할 것이다.php composer.phar update참고:composer.lock과composer.json파일이 동기화되어 있지 않으면install명령어를 실행할 때 경고를 표시할 것이다.
만약 의존성 하나에만 설치나 업데이트를 원한다면 허용 목록에 추가할 수 있다.
php composer.phar update monolog/monolog [...]참고: 라이브러리의 경우 잠금 파일을 반드시 커밋할 필요는 없다.
라이브러리-잠금파일 참고
패키지스트
패키지스트는 메인 컴포저 저장소이다. 컴포저 저장소는 기본적으로 패키지를 얻을 수 있는 곳인 패키지 소스이다. 패키지스트는 모두가 사용하는 중앙 저장소가 되는 것이 목표이다. 이것은 사용 가능한 어떤 패키지든 자동으로require할 수 있다는 것을 의미한다.패키지스트 웹사이트를 방문하면 여러분은 패키지를 둘러보고 검색할 수 있다.
컴포저를 사용하는 어떤 오픈 소스 프로젝트도 자신의 패키지를 패키지스트에 발행하는 것이 좋다. 라이브러리는 컴포저가 사용하는 패키지스트에 있을 필요는 없지만 다른 개발자들이 더 빠르게 탐색하고 도입할 수 있게 해준다.
오토로딩
컴포저는 자동으로 로드하는 정보를 지정한 라이브러리의 경우에vendor/autoload.php 파일을 생성한다. 여러분은 간단하게 이 파일을 포함하고 자유롭게 오토로딩을 할 수 있다.require 'vendor/autoload.php';$log = new Monolog\Logger('name');
$log->pushHandler(new Monolog\Handler\StreamHandler('app.log', Monolog\Logger::WARNING));
$log->addWarning('Foo');composer.json에서 autoload 항목을 추가하는 것으로 오토로더를 여러분의 코드에 추가할 수 있다.{
"autoload": {
"psr-4": {"Acme\\": "src/"}
}
}Acme 네임스페이스로 PSR-4 오토로더를 등록할 것이다.여러분은 디렉토리에서 네임스페이스 매핑을 정의한다.
src 디렉토리는 여러분의 프로젝트 루트에서 vendor 디렉토리와 같은 단계가 될 것이다. 예제 파일이름은 Acme\Foo 클래스를 포함한 src/Foo.php가 될 것이다.autoload 항목을 추가한 후에 여러분은 vendor/autoload.php 파일을 다시 생성하기 위해 dump-autoload를 재실행 해야한다.해당 파일을 포함하는 것 또한 오토로더 인스턴스를 반환합니다, 그래서 여러분은 변수에 해당 반환값을 저장하고 네임스페이스를 더 추가할 수 있다. 예를 들어 이 예제는 테스트 프로그램에서 클래스를 자동으로 불러오는 데에 유용할 수 있다.
$loader = require 'vendor/autoload.php';
$loader->add('Acme\\Test\\', __DIR__);autoload 를 참조하면 된다.
참고: 컴포저는 자신의 오토로드를 제공한다. 만약 여러분이 제공하는 것을 사용하고 싶지 않다면 자신의 오토로드를 구성할 수 있도록 연관배열을 반환하는 vendor/composer/autoload_*.php 파일을 포함하면 된다.
글
0 개의 댓글:
댓글 쓰기